docs.yml

name: Docs

on:
  merge_group:
  pull_request:
  push:
    branches:
      - main
    tags:
      - '*'

permissions:
  contents: read

jobs:
  build-docs:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd  # v6.0.2
        with:
          fetch-depth: 0
          persist-credentials: false

      - name: Install uv and set the python version
        uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e  # v6.8.0
        with:
          python-version: "3.11"
          enable-cache: false

      - name: Install docs dependencies
        run: uv sync --locked --group docs --no-default-groups

      - name: Build Docs
        run: |
          make -C docs

      - name: Upload Pages Artifact
        uses: actions/upload-pages-artifact@fc324d3547104276b827a68afc52ff2a11cc49c9  # v5.0.0
        with:
          path: docs/_build/html

  deploy:
    needs: build-docs
    if: github.event_name != 'pull_request' && github.event_name != 'merge_group'
    permissions:
        pages: write
        id-token: write

    environment:
        name: github-pages
        url: ${{ steps.deployment.outputs.page_url }}

    runs-on: ubuntu-latest
    steps:
        - name: Deploy to GitHub Pages
          id: deployment
          uses: actions/deploy-pages@cd2ce8fcbc39b97be8ca5fce6e763baed58fa128  # v5.0.0