Files
optimiz-rs/.readthedocs.yaml
ThotDjehuty 4b1fa367eb ci(rtd): docs-only build — drop pip install . and openblas apt dep
RTD builds were failing because openblas-build 0.10.16 (transitively pulled by
ndarray-linalg via openblas-src) requires ureq tls feature flags it does not
enable. Cargo.lock is gitignored so RTD always resolves fresh and hits the
broken upstream version.

Building the Rust extension on RTD is unnecessary: the Sphinx pages do not
use autodoc against the Python module, and all inline plots under doc samples
are pre-rendered PNGs committed to docs/source/_static/auto/ by the local
scripts/inject_doc_plots.py author-time pipeline.

This commit makes the RTD job render-only: install docs/requirements.txt and
run Sphinx. No Rust toolchain, no maturin, no OpenBLAS.
2026-05-12 14:42:35 +02:00

27 lines
736 B
YAML

# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
version: 2
build:
os: ubuntu-22.04
tools:
python: "3.11"
sphinx:
configuration: docs/source/conf.py
formats:
- pdf
- epub
python:
install:
- requirements: docs/requirements.txt
# Note: we intentionally do NOT `pip install .` on RTD.
# The Sphinx build only renders RST/MD pages and pre-generated PNG plots
# committed under docs/source/_static/. Building the Rust extension on RTD
# requires OpenBLAS + maturin and routinely breaks because of upstream
# `openblas-build` / `ureq` feature changes. All inline plots are pre-rendered
# locally via scripts/inject_doc_plots.py and committed to the repo.