From df68d68b881da0091ef7813d12ea6b66d4421df7 Mon Sep 17 00:00:00 2001 From: RyanGroneck Date: Tue, 21 Jan 2025 19:29:37 -0500 Subject: [PATCH] api_documentation_workflow --- .github/workflows/build-docs.yml | 8 ++++++++ docs/index.rst | 1 + 2 files changed, 9 insertions(+) diff --git a/.github/workflows/build-docs.yml b/.github/workflows/build-docs.yml index 9f920dfb..fa68184c 100644 --- a/.github/workflows/build-docs.yml +++ b/.github/workflows/build-docs.yml @@ -54,6 +54,14 @@ jobs: run: | pip install -e .[docs] + - name: Generate API Documentation + id: generate-api + working-directory: docs + run: | + sphinx-apidoc -o api ../stardis --separate --force + continue-on-error: true + + - name: Make Sphinx HTML id: make-sphinx-html run: | diff --git a/docs/index.rst b/docs/index.rst index d71826a7..b202037c 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -9,6 +9,7 @@ This is the documentation for STARDIS. Downloading and Installation Quickstart Physics of STARDIS + API Contributing Bibliography