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/warnings_only_severe.txt

tests/golden/warnings_only_severe.txtBrowse 35 files
View on GitHub
171 tokens

682 bytes
Token encoding: o200k_base
Snapshot 39882c6

← Back to SKILL.md
Findings (1):  Tier 3 — warnings:    [T3] myst-xref-missing-cross-extension  doc/source/tune/api.md:7          msg:    'myst' cross-reference target not found: 'development.rst'          fix:    Rewrite as a {doc} role so it resolves to the document and is never ambiguous; drop the extension on the target.  Suggested: {doc}`text <development>`          safety: mechanical Unclassified (1) — no rule matched; resolve with the user, then file a skill-improvement ticket to add a rule:  doc/source/tune/index.md:42: SEVERE: Title level inconsistent: Suppressed (0) — known-benign, not actionable: Next: apply the fixes above, then rebuild and re-run to confirm clean.
← All Ray skillsProject instructions →