build_docs.yaml

name: docs

on:
  push:
    branches:
      - main
  pull_request:

jobs:
  build_sphinx_docs:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          # Need to clone everything to determine version from git.
          fetch-depth: 0

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: "3.11"
          cache: "pip"
          cache-dependency-path: "setup.cfg"

      - name: Install graphviz
        run: sudo apt-get install graphviz

      - name: Update pip/wheel infrastructure and install uv
        run: |
          python -m pip install --upgrade pip
          pip install uv
          uv pip install --system wheel

      - name: Install documenteer
        run: uv pip install --system 'documenteer[pipelines]==0.8.2'

      - name: Install dependencies
        run: |
          uv pip install --system -r requirements.txt

      - name: Build and install
        run: uv pip install --system --no-deps -v -e .

      - name: Build documentation
        working-directory: ./doc
        run: package-docs build -W