.github/workflows/docs.yml

name: Deploy docs

on:
  push:
    branches: [main]
    paths:
      - "docs/**"
      - "mkdocs.yml"
  workflow_dispatch:

permissions:
  pages: write
  id-token: write

concurrency:
  group: docs
  cancel-in-progress: true

jobs:
  deploy:
    name: Build & deploy docs
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.12"

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

      - name: Build
        run: mkdocs build --strict

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

      - id: deployment
        uses: actions/deploy-pages@v4