Fix Sphix Docs
ListedThis AI fixes outdated or broken Sphinx documentation, ensuring accurate and reliable guides for your projects – a crucial step for clarity & usability.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add tradingstrategy-ai/web3-ethereum-defi --skill fix-sphix-docs -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
tradingstrategy-ai
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
We could not read this skill's source, so none of the checks below were run.
About this skill
fix-sphix-docs
What it does
This skill automatically identifies and corrects errors in Sphinx documentation files. It scans for broken links, missing references, and syntax issues to ensure your technical docs are accurate and buildable.
When to use it
- You have recently updated code or API definitions and need to verify that existing documentation still references them correctly.
- Your CI/CD pipeline is failing due to Sphinx build errors related to missing modules or invalid link targets.
- You want to clean up legacy documentation before publishing a new version of your project.
Key capabilities
- Scans
.rstand.mdfiles for broken cross-references and hyperlinks. - Detects undefined roles, directives, and labels within the Sphinx configuration.
- Generates a report highlighting specific line numbers and types of errors found.
Example prompts
- "Run fix-sphix-docs on my
docs/directory to find any broken links before I deploy." - "Check if the new API endpoint added in version 2.0 is correctly documented without errors."
- "Scan the entire documentation tree and list all missing references that are causing build failures."
Tips & gotchas
Ensure your Sphinx configuration file (conf.py) is up to date, as the skill relies on it to validate references accurately. This tool focuses on structural integrity; it does not rewrite content for clarity or style.