Major Release: v1.0 #87
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: docs | |
| on: [push, pull_request, workflow_dispatch] | |
| permissions: | |
| contents: write | |
| jobs: | |
| docs: | |
| if: github.ref == 'refs/heads/main' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v4 | |
| - uses: actions/setup-python@v5 | |
| with: | |
| python-version: 3.11 | |
| - name: Install Poetry | |
| run: | | |
| curl -sSL https://install.python-poetry.org | python3 - | |
| - name: Install dependencies | |
| run: | | |
| poetry install | |
| - name: Sphinx build | |
| run: | | |
| mkdir gh-pages | |
| touch gh-pages/.nojekyll | |
| cd docs/ | |
| poetry run sphinx-build -b html . _build | |
| cp -r _build/* ../gh-pages/ | |
| - name: Deploy documentation | |
| if: github.event_name == 'push' | |
| uses: JamesIves/github-pages-deploy-action@4.1.4 | |
| with: | |
| branch: gh-pages | |
| folder: gh-pages |