deploy-docs.yml

name: Deploy Documentation

on:
  push:
    branches:
      - main
    paths:
      - "**.md"
      - "mkdocs.yml"
      - ".github/workflows/deploy-docs.yml"
  workflow_dispatch:

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

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.13"

      - name: Install dependencies
        run: |
          pip install \
            "mkdocs>=1.6,<2" \
            "mkdocs-material>=9.5,<10" \
            "pymdown-extensions>=10.0,<11"

      - name: Build site
        run: |
          # mkdocs rejects docs_dir: "." because site_dir would be inside it.
          # Move mkdocs.yml to a parent directory so docs_dir points to the repo.
          mkdir -p /tmp/mkdocs-build
          cp mkdocs.yml /tmp/mkdocs-build/mkdocs.yml
          cd /tmp/mkdocs-build
          sed -i "s|^docs_dir:.*|docs_dir: $GITHUB_WORKSPACE|" mkdocs.yml
          sed -i "s|^site_dir:.*|site_dir: /tmp/mkdocs-site|" mkdocs.yml
          mkdocs build
        env:
          ENABLE_PDF_EXPORT: 0

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: /tmp/mkdocs-site

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