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/golden/known_suppressed.txt

tests/golden/known_suppressed.txtBrowse 35 files
View on GitHub
105 tokens

387 bytes
Token encoding: o200k_base
Snapshot 39882c6

← Back to SKILL.md
Build: state=Finished  success=False  exit=1  build finished with problems, 2 warnings. Findings (0):  (none) Unclassified (0) — no rule matched; resolve with the user, then file a skill-improvement ticket to add a rule: Suppressed (2) — known-benign, not actionable:  collections-fetched-footnotes (DOC-1258): 1  misc-copy-overwrite (DOC-1257): 1 ✓ No actionable warnings.
← All Ray skillsProject instructions →