Fix Sphix Docs

Fix errors and warnings in Sphinx docs build Use when this capability is needed.

tomevault-io 27f899f 2 files · 1.6 KB Updated

File contents

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

  1. 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.
  2. Check the output warnings and errors you could attempt to fix. DON'T TOUCH AUTO GENERATED RST FILES. These are in _autosummary folders like _autosummary_d2. These folders will be recreated by user with a special command you do not know.
  3. Report made changes
  4. Ask a permission to open a PR

Converted and distributed by TomeVault — claim your Tome and manage your conversions.

tomevault-io/skills-registry/tree/main/tradingstrategy-ai--web3-ethereum-defi--fix-sphinx-docs commit 27f899f3ea

Frequently asked questions

npx skillmds@latest add tomevault-io/fix-sphix-docs