From 4b1c8d16f72bb5d8f2eb8a2e8dde35abdd2f2a88 Mon Sep 17 00:00:00 2001 From: hathach Date: Mon, 29 Jun 2026 10:16:25 +0700 Subject: docs: add build-doc tooling and a README for every example Documentation tooling: - Add the `build-doc` skill and `tools/build_doc.py` wrapper for local Sphinx builds (clean / -W / open). - Enable Markdown (MyST) in conf.py and auto-collect examples/{device,host,dual}/*/README.md into a 3-level Examples nav (Examples > Device/Host/Dual > example), noting each page's source location and normalizing headings to a single H1. - Remove the stale `.claude/commands/build-doc.md`; point the AGENTS.md Documentation section at the skill. Example docs: - Add a README.md for every device/host/dual example: what it does, USB interface table, notable tusb_config.h settings, generic CMake + Make build steps, and how to try it. - Fold each *_freertos variant into its base README, noting the FreeRTOS source path and any RTOS-specific behavior. Generated docs/examples/ output is git-ignored. Builds clean with `sphinx-build -W`. Co-Authored-By: Claude Opus 4.8 (1M context) --- docs/index.rst | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'docs/index.rst') diff --git a/docs/index.rst b/docs/index.rst index 39d30a038..6d212d8cb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -11,6 +11,14 @@ faq troubleshooting +.. toctree:: + :maxdepth: 2 + :caption: Examples + + examples/device/index + examples/host/index + examples/dual/index + .. toctree:: :maxdepth: 1 :caption: Project Info -- cgit v1.3.1