fix-sphix-docs

Fix Sphinx build warnings and errors in reST and MyST sources.

823|185|Updated Jan 30, 2022
One-click install
npx skills add https://github.com/tradingstrategy-ai/web3-ethereum-defi --skill fix-sphix-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fix-sphix-docs
Source: https://github.com/tradingstrategy-ai/web3-ethereum-defi/tree/main/.claude/skills/fix-sphinx-docs
Command: npx skills add https://github.com/tradingstrategy-ai/web3-ethereum-defi --skill fix-sphix-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Sphinx documentation builds often fail or warn, causing stalled docs deployment and reduced user trust. This Skill automatically identifies and fixes common Sphinx build errors and warnings.

Core Features & Use Cases

  • Automatically detects common Sphinx build errors and warnings.
  • Applies safe fixes to reST and MyST sources without touching autogenerated content.
  • Improves documentation reliability in CI/CD and local development.

Quick Start

Run the fix-sphix-docs workflow to scan the docs directory and apply safe fixes within a controlled timeout.

Frequently Asked Questions about fix-sphix-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically fix Sphinx documentation build errors?

To automatically fix Sphinx documentation build errors, use this Skill to scan your docs directory and apply safe fixes to reST or MyST sources. It targets build-time warnings, missing references, and broken cross-links within a controlled timeout.

Why does my Sphinx build fail with missing references and broken cross-links?

Sphinx builds often fail with missing references and broken cross-links due to inconsistencies in source files. This Skill identifies these common warnings and applies automated fixes to stabilize the documentation deployment.

Can I use this to fix MyST and reST source files in Python projects?

Yes, you can use this Skill to fix MyST and reST source files in Python projects. It specifically parses and modifies these formats while avoiding autogenerated content to safely resolve build warnings.

What is the best way to resolve Sphinx warnings without touching autogenerated content?

The best way to resolve Sphinx warnings without touching autogenerated content is to apply targeted fixes to manually written reST and MyST sources. This Skill runs sphinx-build within a timeout and safely patches only the relevant files.

How do I stabilize Sphinx documentation builds in CI/CD pipelines?

To stabilize Sphinx documentation builds in CI/CD pipelines, automatically detect and address common build-time warnings before deployment. This Skill scans sources and applies safe fixes within a controlled timeout to improve reliability.