builddoc.yml

name: Render documentation

on:
  push:
  pull_request:
  workflow_dispatch:

permissions:
  contents: read

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

env:
  FORCE_COLOR: "1"
  UV_SYSTEM_PYTHON: "1"  # make uv do global installs

jobs:
  verbose:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v4
    - name: Set up Python
      uses: actions/setup-python@v5
      with:
        python-version: "3"
    - name: Install graphviz
      run: sudo apt-get install --no-install-recommends --yes graphviz
    - name: Install uv
      run: >
        curl --no-progress-meter --location --fail
        --proto '=https' --tlsv1.2
        "https://astral.sh/uv/install.sh"
        | sh
    - name: Install dependencies
      run: uv pip install .[docs]
    - name: Render the documentation
      run: >
        sphinx-build
        -M html ./doc ./build/sphinx
        --verbose
        --jobs=auto
        --show-traceback
        --fail-on-warning