name: Verify docs generation

# Runs on pushes to master and all pull requests

on: # yamllint disable-line rule:truthy

push:

branches: [main, develop]

pull_request:

jobs:

docs:

if: github.event.pull_request.draft == false

runs-on: ubuntu-latest

steps:

- uses: actions/checkout@v2

- uses: actions/cache@v4

id: cache-uv

with:

path: ~/.cache/uv

key: ${{ runner.os }}-python-docs-uv

- name: Setup Python 3.12

uses: actions/setup-python@v5

with:

python-version: '3.12'

- name: Full dependencies

run: |

pip install uv

uv pip install --system "sphinx>=7.4.1,<9.0"

uv pip install --system -r requirements.txt -r docs/docs-requirements.txt torch==2.6.0+cpu torchaudio==2.6.0+cpu --extra-index-url https://download.pytorch.org/whl/cpu

uv pip install --system --editable . --no-deps # already installed pinned deps from requirements.txt, we're good

- name: Generate docs

run: |

cd docs

SPHINXOPTS="-j=auto" make html