This repository has been archived by the owner on May 20, 2024. It is now read-only.
Create doc_pages.yml to generate HTML documentation #6
This file contains 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: DocumentationPages | |
| on: | |
| push: | |
| tags: "*" | |
| pull_request: | |
| branches: | |
| - main | |
| jobs: | |
| build-docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@main | |
| with: | |
| fetch-depth: 0 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: 3.11 | |
| - uses: abatilo/actions-poetry@v3 | |
| - name: install | |
| run: poetry install | |
| - name: Build documentation | |
| run: | | |
| mkdir gh-pages | |
| touch gh-pages/.nojekyll | |
| cd docs/ | |
| poetry run sphinx-build -b html docs/source/ docs/build/ | |
| cp -r docs/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 |