Skip to content

Commit

Permalink
[chore] Fully Automate Doc Generation via GHA
Browse files Browse the repository at this point in the history
  • Loading branch information
John-peterson-coinbase committed Sep 30, 2024
1 parent 105bc8c commit 89fd17d
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
3 changes: 1 addition & 2 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ jobs:
- name: Build Sphinx Documentation
run: |
make docs
cd docs
make html
Expand All @@ -32,5 +33,3 @@ jobs:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./docs/_build/html
keep_files: false


4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -29,3 +29,7 @@ install-deps:
.PHONY: docs
docs:
sphinx-apidoc -f -o docs/ ./cdp/

.PHONY: local-docs
local-docs: docs
cd docs && make html && open ./_build/html/index.html

0 comments on commit 89fd17d

Please sign in to comment.