docs.yml

name: Documentation

on:
  push:
    branches:
      - main
      - master
  workflow_dispatch: # Allows you to run this workflow manually from the Actions tab

# 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:
    name: Build documentation & check links
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-python@v5.1.1
        with:
          python-version: "3.12"
      - run: |
          pip install --constraint=${{ github.workspace }}/.github/workflows/constraints.txt pip
          pip install --constraint=${{ github.workspace }}/.github/workflows/constraints.txt nox
      - name: Build documentation
        run: nox --force-color --session=docs
      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: "docs/_build"
      - name: Check links
        run: nox --force-color --session=linkcheck

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      contents: read
      pages: write
      id-token: write
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4