Host documentation on GitHub Pages #30
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: Documentation | |
| on: | |
| push: | |
| branches: | |
| - main | |
| pull_request: | |
| branches: | |
| - main | |
| workflow_dispatch: | |
| jobs: | |
| doc: | |
| name: Execute and build | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - uses: actions/setup-python@v4 | |
| with: | |
| python-version: "3.10" | |
| - run: pip install -r requirements.txt | |
| - run: jupyter book build docs -W | |
| - uses: actions/upload-pages-artifact@v1 | |
| if: always() | |
| with: | |
| path: docs/_build/html | |
| gh-pages: | |
| name: Upload to GitHub Pages | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| if: github.ref == format('refs/heads/{0}', github.event.repository.default_branch) | |
| needs: | |
| - doc | |
| permissions: | |
| pages: write | |
| id-token: write | |
| runs-on: ubuntu-22.04 | |
| steps: | |
| - id: deployment | |
| uses: actions/deploy-pages@v2 |