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: | ||
| # Runs on pushes targeting the default branch | ||
| push: | ||
| branches: ["master"] | ||
| # Allows you to run this workflow manually from the Actions tab | ||
| workflow_dispatch: | ||
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | ||
| permissions: | ||
| contents: read | ||
| pages: write | ||
| id-token: write | ||
| # Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. | ||
| # However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. | ||
| concurrency: | ||
| group: "pages" | ||
| cancel-in-progress: false | ||
| jobs: | ||
| # Build job | ||
| build: | ||
| # We want to run on external PRs, but not on our own internal PRs as they'll be run | ||
| # by the push to the branch. Without this if check, checks are duplicated since | ||
| # internal PRs match both the push and pull_request events. | ||
| if: | ||
| github.event_name == 'push' || github.event.pull_request.head.repo.full_name != | ||
| github.repository | ||
| strategy: | ||
| fail-fast: false | ||
| matrix: | ||
| os: [ubuntu-latest] | ||
| runs-on: ${{ matrix.os }} | ||
| steps: | ||
| - name: Checkout repo | ||
| uses: actions/checkout@v4 | ||
| - name: Set up Python 3.11 | ||
| uses: actions/setup-python@v5 | ||
| with: | ||
| python-version: "3.11" | ||
| - name: Setup Pages | ||
| uses: actions/configure-pages@v5 | ||
| - name: Install dependencies | ||
| run: | | ||
| python -m pip install uv | ||
| python -m uv pip install --system -r ./docs/requirements.txt | ||
| - name: Build documentation | ||
| run: sphinx-build -a -b html --keep-going ./docs/source ./docs/_build | ||
| - name: Upload artifact | ||
| uses: actions/upload-pages-artifact@v3 | ||
| path: ./docs/_build | ||
| # Deployment job | ||
| deploy: | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| needs: build | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
