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 · 39882c6Scanned 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 ↗
View on GitHub
← Back to SKILL.md
Build: state=Finished  success=False  exit=1  build finished with problems, 2 warnings. Findings (2):  Tier 3 — warnings:    [T3] docutils-inline-markup  doc/source/data/api/doc/ray.data.ReaderFormat.rst:74:<autosummary>:1          msg:    Inline emphasis start-string without end-string.          fix:    Balance or escape the marker in the source docstring, not in the generated stub: wrap literals in double backticks (``*args``, ``**kwargs``), or escape a standalone asterisk (\*).          safety: judgment (needs your call)    [T3] docutils-inline-markup  doc/source/data/api/doc/ray.data.ReaderFormat.rst:74:<autosummary>:1          msg:    Inline strong start-string without end-string.          fix:    Balance or escape the marker in the source docstring, not in the generated stub: wrap literals in double backticks (``*args``, ``**kwargs``), or escape a standalone asterisk (\*).          safety: judgment (needs your call) Unclassified (0) — no rule matched; resolve with the user, then file a skill-improvement ticket to add a rule: Suppressed (0) — known-benign, not actionable: Next: apply the fixes above, then rebuild and re-run to confirm clean.