docs.yml

name: Docs

on:
  pull_request:
  push:
    branches:
      - main

permissions:
  contents: read

concurrency:
  group: docs-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

jobs:
  build:
    name: Build Python API docs
    runs-on: ubuntu-22.04
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Load CI versions
        shell: bash
        run: cat "$GITHUB_WORKSPACE/.github/ci-versions.env" >> "$GITHUB_ENV"

      - name: Setup Rust
        uses: dtolnay/rust-toolchain@stable
        with:
          toolchain: ${{ env.CI_RUST }}

      - name: Cache Rust build
        uses: Swatinem/rust-cache@v2

      - name: Setup Python
        uses: actions/setup-python@v5
        with:
          python-version: ${{ env.CI_PYTHON }}
          cache: pip
          cache-dependency-path: |
            bindings/python/docs/requirements.txt
            bindings/python/pyproject.toml

      - name: Install documentation dependencies
        working-directory: bindings/python
        run: |
          python -m pip install --upgrade pip
          python -m pip install -r docs/requirements.txt

      - name: Install Python bindings
        run: python -m pip install ./bindings/python

      - name: Build documentation
        working-directory: bindings/python
        run: sphinx-build -b html docs/ docs/_build -W