docs.yml

name: Build and publish docs

on:
  workflow_dispatch:
  push:
    branches:
      - main

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
  contents: read
  pages: write
  id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run
# in-progress and latest queued.
concurrency:
  group: "pages"
  cancel-in-progress: true

env:
  UV_CACHE_DIR: /tmp/.uv-cache

jobs:
  build:
    name: Build docs.
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - name: Run sccache-cache
        uses: mozilla-actions/sccache-action@v0.0.5

      - name: Set up uv
        run: curl -LsSf https://astral.sh/uv/0.3.4/install.sh | sh
      - name: "Set up Python"
        uses: actions/setup-python@v5
        with:
          python-version: '3.10'
      - name: Restore uv cache
        uses: actions/cache@v4
        with:
          path: ${{ env.UV_CACHE_DIR }}
          key: uv-${{ runner.os }}-${{ hashFiles('uv.lock') }}
          restore-keys: |
            uv-${{ runner.os }}

      - name: Build docs
        run: |
          cd docs
          ./build.sh
      - name: Upload artifact.
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./docs/build/

      - name: Minimize uv cache
        run: uv cache prune --ci

  publish:
    name: Publish docs.
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Deploy to GitHub Pages.
        id: deployment
        uses: actions/deploy-pages@v4