ossrules.md

sphinx-fix

Diagnose a failing Ray Sphinx / Read the Docs documentation build. Parses the Sphinx warning stream (an RtD build log, a local build, or pasted text), classifies each warning against a rules table, and proposes the canonical fix in severity-tier order. Detects a hard-broken build, segregates known-benign suppressed classes, and lists every unclassified warning. Use when a `docs/readthedocs.com:anyscale-ray` check fails, when asked "why is the docs build failing?" or "what warning is breaking this PR?", or to turn a Sphinx warning dump into an ordered fix list.

Install
npx skills add 'https://github.com/ray-project/ray/tree/master/doc/.claude/skills/sphinx-fix'
Download bundle ↓
master · 39882c6 ↗Scanned 2026-09-17

Contributors

GitHub-linked commit authors for this SKILL.md at the saved revision. Co-authors and history before file renames are not included.

File history ↗

tests/fixtures/autosummary_import_abort.txt

tests/fixtures/autosummary_import_abort.txtBrowse 35 files
View on GitHub
212 tokens

799 bytes
Token encoding: o200k_base
Snapshot 39882c6

← Back to SKILL.md
Build: 4154865   State: Finished   Success: False   Duration: 113sFailing command: python -m sphinx -T -W --keep-going -j auto -b html -d _build/doctrees -D language=en . $READTHEDOCS_OUTPUT/htmlExit code: 1 Running Sphinx v8.2.3[autosummary] generating autosummary for: data/api/loading_data.rst, train/api/doc/ray.train.Trainer.rst Extension error (sphinx.ext.autosummary)! Traceback=========     sphinx.ext.autosummary.ImportExceptionGroup: no module named ray.air.integrations.comet.CometLoggerCallback     sphinx.ext.autosummary.ImportExceptionGroup: no module named ray.air.integrations.comet     sphinx.errors.ExtensionError: Handler <function process_generate_options at 0x7f00> for event 'builder-inited' threw an exception (exception: no module named ray.air.integrations.comet)
← All Ray skillsProject instructions →