From 25a97e54975c6d8939bc5e3d6abb10f7ea41ba66 Mon Sep 17 00:00:00 2001 From: John Peterson Date: Sun, 29 Sep 2024 20:23:09 -0400 Subject: [PATCH] [chore] Fully Automate Doc Generation via GHA --- .github/workflows/publish_docs.yml | 3 +-- Makefile | 4 ++++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml index 82a6012..1472326 100644 --- a/.github/workflows/publish_docs.yml +++ b/.github/workflows/publish_docs.yml @@ -23,6 +23,7 @@ jobs: - name: Build Sphinx Documentation run: | + make docs cd docs make html @@ -32,5 +33,3 @@ jobs: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./docs/_build/html keep_files: false - - diff --git a/Makefile b/Makefile index f44df2e..858161d 100644 --- a/Makefile +++ b/Makefile @@ -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