tinyusb.git/tools/gen_doc.py, branch hil-reportUnnamed repository; edit this file 'description' to name the repository.http://cgit.235523.xyz/tinyusb.git/atom/tools/gen_doc.py?h=hil-report2026-08-20T17:47:27Zdocs: add hardware-in-the-loop rig reference2026-08-20T17:47:27Zhathachthach@tinyusb.org2026-08-20T07:30:59Zurn:sha1:872b4fbdc3c607b522211839a6b3b82e18310a1b
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.
update doc2025-11-11T03:53:39Zhathachthach@tinyusb.org2025-11-11T03:27:47Zurn:sha1:a1ae5b20ccf760282538dd81b9290527757fa9c7move mcu supported to README.rst, separated supported boards to boards.rst2024-12-27T04:34:35Zhathachthach@tinyusb.org2024-12-27T02:58:07Zurn:sha1:824793a428aea082b4ae887ce7a26b4736e1d2ccembed metadata to family.c and board.h to generate supported boards doc2024-12-27T02:11:09Zhathachthach@tinyusb.org2024-12-27T02:11:09Zurn:sha1:6a36c74b10b25f1455d83ba473fff52a9dbcc6d2make all python files executable and standardize interpreter2024-09-17T19:17:12ZShawn Hoffmangodisgovernment@gmail.com2024-09-17T19:17:12Zurn:sha1:616532892d913b7224806ed1e881b72ed66bb3e1increase version as pre-releases, still need more clean up before actual relesae2024-05-24T13:17:53Zhathachthach@tinyusb.org2024-05-24T13:17:53Zurn:sha1:3175aaa0eb32e334b3b55824e93b647da3b69a44update doc, move sponsor to top of the page2023-11-24T12:11:28Zhathachthach@tinyusb.org2023-11-24T12:11:28Zurn:sha1:0e12d36531724f593c16bae9f4ff54a84cd1a01cseparate CFG_TUSB_MEM_SECTION and CFG_TUSB_MEM_ALIGN to2023-03-24T07:05:21Zhathachthach@tinyusb.org2023-03-24T07:02:09Zurn:sha1:71fb6469d4997347f2014daa41839391cc070a74
- 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
update doc and generate deps list2023-03-23T09:33:35Zhathachthach@tinyusb.org2023-03-23T09:33:35Zurn:sha1:f80d11301ea03746d86dd64c651b31bd600772f7