docs.yml

name: Docs

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
    types: [opened, synchronize, ready_for_review]
  workflow_dispatch:

# Read access is enough for documentation builds, including pull requests.
permissions:
  contents: read

# One concurrent deploy; don't cancel an in-progress publish.
concurrency:
  group: pages
  cancel-in-progress: false

jobs:
  preflight:
    uses: ./.github/workflows/preflight.yml

  # The build always runs so the docs stay green even while deploy is off.
  build:
    needs: preflight
    if: needs.preflight.outputs.ok == 'true'
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v7

      - uses: actions/setup-python@v7
        with:
          python-version: "3.12"
          cache: pip
          cache-dependency-path: "**/pyproject.toml"

      - run: rustup toolchain install  # version from rust-toolchain.toml

      - uses: Swatinem/rust-cache@v2
        with:
          workspaces: crates

      # `pip install -e .` compiles the Rust extension. The [docs] extra adds
      # Sphinx, the theme, and jupyter-sphinx.
      - name: Install
        run: pip install -e '.[docs]'

      # Execute every jupyter-execute example and fail on Sphinx warnings.
      - name: Test and build docs
        run: sphinx-build -d docs/_build/doctrees -b html -W --keep-going docs docs/_build/html

      - uses: actions/upload-pages-artifact@v3
        if: github.event_name != 'pull_request'
        with:
          path: docs/_build/html

  deploy:
    # Dormant until docs are turned on: enable GitHub Pages
    # (Settings -> Pages -> Source: GitHub Actions), then set the repository
    # variable DEPLOY_DOCS=true (Settings -> Secrets and variables -> Actions).
    if: github.event_name != 'pull_request' && vars.DEPLOY_DOCS == 'true'
    needs: build
    runs-on: ubuntu-latest
    permissions:
      pages: write
      id-token: write
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - id: deployment
        uses: actions/deploy-pages@v4