docs.yml

name: Documentation

on:
  push:
    branches:
      - main
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"
      - "mkdocs.yml"
      - "requirements/docs.txt"
      - "README.md"
      - "SECURITY.md"
      - "CONTRIBUTING.md"
      - "SOURCE_AVAILABILITY.md"
      - "THIRD_PARTY_NOTICES.md"
  pull_request:
    paths:
      - ".github/workflows/docs.yml"
      - "docs/**"
      - "mkdocs.yml"
      - "requirements/docs.txt"
      - "README.md"
      - "SECURITY.md"
      - "CONTRIBUTING.md"
      - "SOURCE_AVAILABILITY.md"
      - "THIRD_PARTY_NOTICES.md"
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: documentation-${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: Build documentation site
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - uses: actions/checkout@v7
      - uses: actions/setup-python@v7
        with:
          python-version: "3.13"
          cache: pip
          cache-dependency-path: requirements/docs.txt
      - name: Install documentation dependencies
        run: python -m pip install --disable-pip-version-check --requirement requirements/docs.txt
      - name: Build strict documentation site
        run: python -m mkdocs build --strict --clean
      - uses: actions/configure-pages@v6
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
      - uses: actions/upload-pages-artifact@v5
        if: github.event_name == 'push' && github.ref == 'refs/heads/main'
        with:
          path: site

  deploy:
    name: Publish documentation site
    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
    needs: build
    runs-on: ubuntu-latest
    timeout-minutes: 10
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    permissions:
      pages: write
      id-token: write
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v5