docs.yml

name: Deploy Documentation

on:
  push:
    branches:
      - main
      - master
  workflow_dispatch:  # Allow manual triggering

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

jobs:
  deploy:
    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.12'

      - name: Install uv
        uses: astral-sh/setup-uv@v4
        with:
          version: "latest"

      - name: Install dependencies
        run: |
          uv sync --extra docs

      - name: Setup Pages
        uses: actions/configure-pages@v4

      # No PYTHONPATH here on purpose. mkdocs.yml's mkdocstrings `paths: ["."]`
      # (resolved relative to the config file, so it is the repo root regardless
      # of cwd) is the single source of truth for the import root. This step used
      # to set PYTHONPATH to the workspace, which was the only reason the build
      # worked while `paths` pointed at the wrong directory — masking a config
      # error that made `mkdocs build` fail for anyone running it locally.
      - name: Build documentation
        run: |
          uv run mkdocs build

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

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4