docs.yml

name: Deploy docs

on:
  push:
    branches: [master]
    paths:
      - 'docs/**'
      - 'mkdocs.yml'
      - '.github/workflows/docs.yml'
  workflow_dispatch:

permissions:
  contents: write   # required for gh-deploy to push to gh-pages branch

concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: false   # let one finish before next starts (avoid corrupt gh-pages)

jobs:
  deploy:
    runs-on: ubuntu-latest
    timeout-minutes: 10
    steps:
      - name: Checkout
        uses: actions/checkout@v6
        with:
          fetch-depth: 0   # full history so mkdocs revision-date plugins work

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.12'
          cache: pip
          cache-dependency-path: docs/requirements.txt

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

      - name: Build site (verify before deploy)
        run: mkdocs build --strict

      - name: Deploy to gh-pages
        run: mkdocs gh-deploy --force --no-history