From 743f732a29f8a9c3982a5d03f36ebcf5b300b1c3 Mon Sep 17 00:00:00 2001 From: arturo Date: Wed, 12 Jul 2023 14:41:12 -0400 Subject: [PATCH] autodoc build workflow --- .github/workflows/autobuild.yml | 33 +++++++++++++++++++++++++++++++++ docs/source/conf.py | 1 + 2 files changed, 34 insertions(+) create mode 100644 .github/workflows/autobuild.yml diff --git a/.github/workflows/autobuild.yml b/.github/workflows/autobuild.yml new file mode 100644 index 00000000..bb63c7b6 --- /dev/null +++ b/.github/workflows/autobuild.yml @@ -0,0 +1,33 @@ +name: Publish Sphinx Documentation + +on: + push: + branches: + - main + +jobs: + publish_sphinx_docs: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - uses: actions/checkout@v3 + - uses: actions/setup-python@v3 + with: + python-version: "3.10" + - name: Install dependencies + run: | + pip install -e . + pip install sphinx + pip install pydata-sphinx-theme + - name: Sphinx build + run: | + cd docs + make html + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + with: + publish_branch: gh-pages + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/ + force_orphan: true diff --git a/docs/source/conf.py b/docs/source/conf.py index 887dc04e..b4375eee 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -36,6 +36,7 @@ 'sphinx.ext.mathjax', 'sphinx.ext.autosummary', "sphinx.ext.intersphinx", + "sphinx.ext.githubpages", ] autodoc_default_options = { 'member-order': 'bysource',