mirror of
https://github.com/hathach/tinyusb.git
synced 2026-08-18 11:02:16 +00:00
4b1c8d16f7
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>
35 lines
610 B
ReStructuredText
35 lines
610 B
ReStructuredText
.. include:: ../README_processed.rst
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Information
|
|
|
|
getting_started
|
|
integration
|
|
porting
|
|
reference/index
|
|
faq
|
|
troubleshooting
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Examples
|
|
|
|
examples/device/index
|
|
examples/host/index
|
|
examples/dual/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Project Info
|
|
|
|
info/index
|
|
|
|
.. toctree::
|
|
:caption: External Links
|
|
:hidden:
|
|
|
|
Source Code <https://github.com/hathach/tinyusb>
|
|
Issue Tracker <https://github.com/hathach/tinyusb/issues>
|
|
Discussions <https://github.com/hathach/tinyusb/discussions>
|