diff --git a/.github/workflows/sphinx_render_docs.yml b/.github/workflows/sphinx_render_docs.yml new file mode 100644 index 0000000..1088e21 --- /dev/null +++ b/.github/workflows/sphinx_render_docs.yml @@ -0,0 +1,35 @@ +name: "Sphinx: Render docs" + +on: push + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Setup Python + uses: actions/setup-python@v5 + with: + python-version: '3.8' + - uses: actions/checkout@v4 + - name: Install sphinx and build documentation with sphinx + run: | + python --version + pip install sphinx sphinx_rtd_theme sphinxcontrib-email + pip install -e . + - name: Build HTML + uses: ammaraskar/sphinx-action@master + with: + docs-folder: "docs/" + - name: Upload artifacts + uses: actions/upload-artifact@v4 + with: + name: html-docs + path: docs/build/html/ + - name: Deploy + uses: peaceiris/actions-gh-pages@v3 + if: github.ref == 'refs/heads/main' + with: + github_token: ${{ secrets.GITHUB_TOKEN }} + publish_dir: docs/build/html