docs.yml

name: Deploy Sphinx Documentation

on:
  push:
    branches: [ main ]
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - uses: actions/checkout@v4

      - name: Install uv
        uses: astral-sh/setup-uv@v2

      - name: Set up Python 3.13
        run: uv python install 3.13

      - name: Install the project
        run: uv sync --no-dev --extra docs

      - name: Build documentation
        run: uv run sphinx-build -b html docs/ docs/_build/

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: docs/_build

  deploy:
    needs: build
    runs-on: ubuntu-latest

    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
    permissions:
      pages: write      # to deploy to Pages
      id-token: write   # to verify the deployment originates from an appropriate source

    # Deploy to the github-pages environment
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}

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