deploy-docs.yml

name: Deploy MkDocs to GitHub Pages

on:
  push:
    branches:
      - main
  # Allow manual trigger from the Actions tab
  workflow_dispatch:

# Required for deploying to GitHub Pages via OIDC token
permissions:
  contents: read
  pages: write
  id-token: write

# Only allow one deployment at a time; cancel any in-progress run
concurrency:
  group: "pages"
  cancel-in-progress: false

jobs:
  # ── Build ──────────────────────────────────────────────────────────────────
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.x"

      - name: Install MkDocs Material
        run: pip install mkdocs-material

      - name: Build MkDocs site
        run: mkdocs build --strict

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

  # ── Deploy ─────────────────────────────────────────────────────────────────
  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