MakerFLOSS/scripts
sjat 74b43ed5af
All checks were successful
Build docs site / build (push) Successful in 54s
Build slides / build (push) Successful in 1m13s
test(rack): guard empty rack value and cover 0U/both/multi-rack rendering
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-06-24 14:05:56 +02:00
..
gen_overview.py fix(docs-ci): unblock build by tolerating "?" placeholders in hardware frontmatter 2026-05-27 10:31:46 +02:00
gen_rack.py test(rack): guard empty rack value and cover 0U/both/multi-rack rendering 2026-06-24 14:05:56 +02:00
mkdocs_hooks.py docs(hardware): drop the model field 2026-05-27 10:37:04 +02:00
overview_config.yml feat(hardware): allow rack item kinds (pdu, patch-panel, shelf, blank, ups, kvm) 2026-06-24 13:40:01 +02:00
README.md docs: add proper README at repo root and per-tree READMEs 2026-05-18 17:13:50 +02:00

scripts/

Build helpers for the documentation site.

  • gen_overview.py — generates a category index table from per-item YAML frontmatter (currently used for docs/hardware/index.md). Configured by overview_config.yml. Run via make docs-index; CI drift-checks it via make docs-check.
  • mkdocs_hooks.py — MkDocs build hook that renders a Specs table on each hardware host page from its frontmatter, sharing fmt_* helpers with gen_overview.py so the host page and the index row stay in sync.
  • overview_config.yml — schema (required fields, enums) and table layout for gen_overview.py.