summaryrefslogtreecommitdiff
path: root/tools/gen_doc.py
AgeCommit message (Collapse)Author
8 daysdocs: add hardware-in-the-loop rig referencehathach
Document the ci and hfp HIL rigs in enough detail to reproduce one: bill of materials with photos, BIOS/IOMMU and vfio-pci passthrough on the Proxmox host, the Renesas uPD720201 firmware install, the guest software and permissions, the one-hub-per-root-port USB topology rule and the per-box split of probe and DUT hubs, how CI drives the rigs, and the operational gotchas. The attached-board table is generated from test/hil/tinyusb.json and test/hil/hfp.json by tools/gen_doc.py into docs/reference/hil_boards.md, which the page includes. Sphinx excludes that partial so it is not also built as an orphan document. Also exclude docs/superpowers/ from the Sphinx build: it holds internal plans, specs and handoffs rather than published documentation, and since nothing references them from a toctree each emitted "document isn't included in any toctree" -- 26 warnings in total, so build_doc.py -W could never pass. It now does.
2025-11-11update dochathach
2024-12-27move mcu supported to README.rst, separated supported boards to boards.rsthathach
2024-12-27embed metadata to family.c and board.h to generate supported boards dochathach
2024-09-17make all python files executable and standardize interpreterShawn Hoffman
2024-05-24increase version as pre-releases, still need more clean up before actual relesaehathach
2023-11-24update doc, move sponsor to top of the pagehathach
2023-03-24separate CFG_TUSB_MEM_SECTION and CFG_TUSB_MEM_ALIGN tohathach
- CFG_TUD_MEM_SECTION and CFG_TUD_MEM_ALIGN - CFG_TUH_MEM_SECTION and CFG_TUH_MEM_ALIGN - fix missing mem section and align for host
2023-03-23update doc and generate deps listhathach