docs.yml

name: Deploy docs

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

# Required so the workflow can publish to the GitHub Pages environment
# managed automatically by `actions/deploy-pages`.
permissions:
  contents: read
  pages: write
  id-token: write

# Avoid clobbering each other when several pushes land back-to-back.
concurrency:
  group: "pages"
  cancel-in-progress: true

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
      - uses: astral-sh/setup-uv@v8.1.0
        with:
          enable-cache: true
      - name: Set up Python
        run: uv python install 3.11
      - name: Install with docs extras (CPU torch)
        env:
          PIP_EXTRA_INDEX_URL: https://download.pytorch.org/whl/cpu
        run: uv sync --extra docs
      - name: Build site
        run: uv run mkdocs build --clean --strict --site-dir _site
      - uses: actions/upload-pages-artifact@v3
        with:
          path: _site

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