mirror of
https://github.com/hathach/tinyusb.git
synced 2026-08-18 02:53:35 +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>
94 lines
1.2 KiB
Plaintext
94 lines
1.2 KiB
Plaintext
html
|
|
latex
|
|
hil_report.md
|
|
hil_report.json
|
|
*.a
|
|
*.d
|
|
*.o
|
|
*.P
|
|
*.axf
|
|
*.bin
|
|
*.elf
|
|
*.env
|
|
*.ind
|
|
*.log
|
|
*.sarif
|
|
*.map
|
|
*.obj
|
|
*.jlink
|
|
*.emSession
|
|
*.ninja*
|
|
*.eww
|
|
*.ewp
|
|
*.ewt
|
|
*.ewd
|
|
*.hex
|
|
.venv/
|
|
cmake_install.cmake
|
|
CMakeCache.txt
|
|
settings/
|
|
.settings/
|
|
.vscode/
|
|
.gdb_history
|
|
/examples/*/*/build*
|
|
test_old/
|
|
tests_obsolete/
|
|
_build/
|
|
build/
|
|
/examples/*/*/ses
|
|
/examples/*/*/ozone
|
|
/examples/obsolete
|
|
hw/bsp/**/cubemx/*/
|
|
.mxproject
|
|
# coverity intermediate files
|
|
cov-int
|
|
# cppcheck build directories
|
|
*-build-dir
|
|
/_bin/
|
|
__pycache__
|
|
cmake-build/
|
|
cmake-build-*
|
|
sdkconfig
|
|
.PVS-Studio
|
|
.vscode/
|
|
CMakeFiles
|
|
Debug
|
|
RelWithDebInfo
|
|
Release
|
|
BrowseInfo
|
|
.cmake_build
|
|
README_processed.rst
|
|
docs/examples/
|
|
.worktrees
|
|
cmake-metrics/
|
|
# Directories fetched by tools/get_deps.py - not to be committed
|
|
lib/CMSIS_5/
|
|
lib/CMSIS_6/
|
|
lib/FreeRTOS-Kernel/
|
|
lib/fatfs/
|
|
lib/lwip/
|
|
lib/sct_neopixel/
|
|
lib/threadx/
|
|
tools/linkermap/
|
|
tools/uf2/
|
|
hw/mcu/allwinner/
|
|
hw/mcu/analog/
|
|
hw/mcu/artery/
|
|
hw/mcu/broadcom/
|
|
hw/mcu/bridgetek/ft9xx/ft90x-sdk/
|
|
hw/mcu/gd/
|
|
hw/mcu/hpmicro/
|
|
hw/mcu/infineon/
|
|
hw/mcu/microchip/
|
|
hw/mcu/mindmotion/
|
|
hw/mcu/nordic/nrfx/
|
|
hw/mcu/nuvoton/
|
|
hw/mcu/nxp/
|
|
hw/mcu/raspberry_pi/
|
|
hw/mcu/renesas/
|
|
hw/mcu/silabs/
|
|
hw/mcu/sony/cxd56/spresense-exported-sdk/
|
|
hw/mcu/st/
|
|
hw/mcu/ti/
|
|
hw/mcu/wch/
|