Fix Sphix Docs
Documentsfix-sphix-docsFix Sphix Docs is an Agent Skill for documents published in the tradingstrategy-ai/web3-ethereum-defi repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Fix errors and warnings in Sphinx docs build
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/tradingstrategy-ai/web3-ethereum-defi/blob/HEAD/.claude/skills/fix-sphinx-docs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/fix-sphix-docs, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Fix errors and warnings in Sphinx docs build
This skill iterates over Sphinx docs build and attempt to fix easily addressable errors and warnings.
Steps
- Run Sphinx build:
(source ./.venv/bin/activate && cd ./docs/ && make html), but with a twist: figure out how to abort after 60 second do not try to wait for the full build takes too long. - Check the output warnings and errors you could attempt to fix. DON'T TOUCH AUTO GENERATED RST FILES. These are in
_autosummaryfolders like_autosummary_d2. These folders will be recreated by user with a special command you do not know. - Report made changes
- Ask a permission to open a PR