docs.yml

name: Deploy Docs

# Independent of the release workflow: this deploys the documentation site
# whenever docs content actually changes on main, regardless of commit
# message. Also runnable manually from the Actions tab.
on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "mkdocs.yml"
      - ".github/workflows/docs.yml"
  workflow_dispatch:

permissions:
  contents: read
  pages: write
  id-token: write

# Only one concurrent deployment; let an in-flight one finish rather than
# cancel it, but don't queue more than the latest.
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.11"

      - name: Install MkDocs Material
        run: pip install -r docs/requirements.txt

      - name: Build site
        run: mkdocs build --strict --site-dir _site

      - uses: actions/upload-pages-artifact@v3
        with:
          path: _site

  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4