Commit Graph

11 Commits

Author SHA1 Message Date
ba32b46ebd docs: address Copilot review on the example READMEs
- Order CFG_TUH_DEVICE_MAX before CFG_TUH_HID in the host config snippets
  (cdc_msc_hid, hid_controller) so the documented snippet has no forward
  macro reference when copied into tusb_config.h.
- Fix stale `examples.rst` references: the generator now writes per-group
  `docs/examples/<group>/index.rst` pages, so update the conf.py comment and
  the build-doc SKILL.md accordingly.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
2026-06-29 10:42:41 +07:00
4b1c8d16f7 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) <noreply@anthropic.com>
2026-06-29 10:16:25 +07:00
22c2ece872 try to get render right
Signed-off-by: HiFiPhile <admin@hifiphile.com>
2026-06-02 11:30:33 +02:00
b4e92f63c6 fix windows build
Signed-off-by: HiFiPhile <admin@hifiphile.com>
2026-03-14 09:19:24 +01:00
a1ae5b20cc update doc 2025-11-11 10:53:39 +07:00
9dd67b19e2 revert unnecessary Sphinx config changes 2025-10-20 21:14:28 +02:00
e4ff88f364 WIP improved docs (feat. LLM) 2025-10-20 21:07:04 +02:00
de38e53271 update docs, remove uses.rst, structure.rst. Refactor docs, use README.rst for docs index.rst 2024-12-27 17:48:45 +07:00
616532892d make all python files executable and standardize interpreter 2024-09-17 12:17:12 -07:00
c52c9cda91 after commit: eae4132 this dependency is no longer required
Signed-off-by: Rafael Silva <perigoso@riseup.net>
2021-12-02 10:24:19 +00:00
bf99adc3c9 docs: setup sphinx docs
Signed-off-by: perigoso <perigoso@riseup.net>
2021-07-30 12:46:15 +01:00