docs.yaml

name: Docs

on:
  push:
    branches: [master]
    # Only rebuild when docs content or docs config changes.
    paths:
      - '**.md'
      - mkdocs.yaml
      - .github/overrides/**
      - .github/docs-requirements.txt
      - .github/workflows/docs.yaml
  workflow_dispatch:

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

# Allow one concurrent deployment, do not cancel an in-progress production deploy.
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      - uses: actions/setup-python@ece7cb06caefa5fff74198d8649806c4678c61a1 # v6
        with:
          python-version: "3.x"
          cache: pip
          cache-dependency-path: .github/docs-requirements.txt
      - run: pip install -r .github/docs-requirements.txt
      - run: mkdocs build
      - uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9 # v5
        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@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128 # v5