Build TinyUSB Docs
SkillFiles & storageGuides your agent to build, preview, and test the TinyUSB Sphinx docs locally and regenerate auto-generated reference files.
Available today. Use it from your connected AI after setup.
No other account needed.
Connect ahel once, and every AI you use reads what you have installed.
Then ask your AI: use the Build TinyUSB Docs skill
About this capability
Use when building, previewing, or testing the TinyUSB Sphinx docs locally (docs/ → HTML), chasing Sphinx warnings, understanding how example READMEs get into the docs, or regenerating the auto-generated reference files after adding a board, a dependency, or a HIL rig board (boards.rst, dependencies.
What this skill tells your AI
The instructions your AI receives, as published by hathach/tinyusb in .claude/skills/build-doc/SKILL.md and read by ahel’s review.
Build & preview
pip install -r docs/requirements.txt # one-time
python3 tools/build_doc.py -o # build docs/_build/ and open it
tools/build_doc.py wraps sphinx-build: -c clean, -W fail on warnings, -o open. Raw form: sphinx-build -b html docs docs/_build.
- Pages can be
.rstor.md(MyST). ExampleREADME.mds underexamples/{device,host,dual}/*/are auto-collected at build time intodocs/examples/(per-groupindexpages, git-ignored) — add/rename an example and just rebuild; edit the source README, never the generated copies. - Watch the output for
WARNING:(broken refs, missing toctree entries).
Regenerate after adding a board or dependency
Run from the repo root; docs/reference/*.rst, docs/reference/hil_boards.md and the preset JSONs are generated — don't hand-edit.
| Added | Run |
|---|---|
Board (hw/bsp/FAMILY/boards/) | python3 tools/gen_doc.py + python3 tools/gen_presets.py |
Dependency (edited tools/get_deps.py) | python3 tools/gen_doc.py |
HIL board roster (test/hil/tinyusb.json, hfp.json) | python3 tools/gen_doc.py |
gen_doc.py→docs/reference/boards.rst+dependencies.rst+hil_boards.md(the roster partial included byhardware-in-the-loop.md). Needspandas+tabulate(not inrequirements.txt) —pip install pandas tabulateif it errors.gen_doc.pyrewrites all three files whichever one you came for; revert any unrelated churn inboards.rst/dependencies.rstbefore committing.gen_presets.py→hw/bsp/BoardPresets.json+ per-exampleCMakePresets.json.
Then rebuild and git diff the regenerated files; commit them with the board/dep change.
Signals
- GitHub stars
- 7k
- Forks
- 2k
- Last commit
- Sep 2026
Advanced
- Catalog kind
- skill
- Gateway key
build-doc- Source
- github.com/hathach/tinyusb