docs.yml

name: Build and publish docs

on:
  workflow_dispatch:
  push:
    branches:
      - main
    # only run if there are changes in the hugr-py directory
    paths:
      - 'hugr-py/**'

# 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

jobs:
  build:
    name: Build docs.
    runs-on: ubuntu-latest
    defaults:
      run:
        working-directory: ./hugr-py
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
          fetch-tags: true

      - name: Set up uv
        uses: astral-sh/setup-uv@v4
        with:
          version: "0.4.18"
          enable-cache: true
      - name: Install Python
        run: uv python install 3.13

      - name: Build docs
        run: |
          cd docs
          uv run ./build.sh

      - name: Upload artifact.
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./hugr-py/docs/build

  publish:
    name: Publish docs.
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    if: github.event_name != 'workflow_dispatch' || github.ref == 'refs/heads/main'
    steps:
      - name: Setup Pages
        uses: actions/configure-pages@v5
      - name: Deploy to GitHub Pages.
        id: deployment
        uses: actions/deploy-pages@v4