diff options
| author | hathach <[email protected]> | 2026-08-20 14:30:59 +0700 |
|---|---|---|
| committer | hathach <[email protected]> | 2026-08-21 00:47:27 +0700 |
| commit | 872b4fbdc3c607b522211839a6b3b82e18310a1b (patch) | |
| tree | ebb5e40aa6774417ad2d3f2f8968dd17c78b83ba /tools/make_release.py | |
| parent | 9466f3cda69b052679e7bb078b5cf7906ddbea27 (diff) | |
docs: add hardware-in-the-loop rig reference
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.
Diffstat (limited to 'tools/make_release.py')
| -rwxr-xr-x | tools/make_release.py | 1 |
1 files changed, 1 insertions, 0 deletions
diff --git a/tools/make_release.py b/tools/make_release.py index 65226834f..ec4755f34 100755 --- a/tools/make_release.py +++ b/tools/make_release.py @@ -59,6 +59,7 @@ with open(f_sonar_properties, 'w') as f: # gen docs gen_doc.gen_deps_doc() gen_doc.gen_boards_doc() +gen_doc.gen_hil_boards_doc() # gen presets gen_presets.main() |