docs.yml

name: Docs

on:
  pull_request:
  push:
    branches:
      - main

permissions:
  contents: read

env:
  JUSTFILE: ${{ github.workspace }}/pipeline.just

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: Create virtual environment
        run: |
          python -m venv .venv
          echo "VIRTUAL_ENV=$GITHUB_WORKSPACE/.venv" >> "$GITHUB_ENV"
          echo "$GITHUB_WORKSPACE/.venv/bin" >> "$GITHUB_PATH"

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

      - name: Install maturin and Python build dependencies
        run: pip install -r requirements.txt

      - name: Setup just
        uses: extractions/setup-just@v3

      - name: Build documentation
        run: just --justfile "$JUSTFILE" build-python-docs