Skip to content

toolroom.pages

Write one reference page per tool, plus the index table.

Rendered from the records rather than from the installed tools, so the docs build needs nothing on PATH and says exactly what the records hold. The stubs the pages point at are written as the module toolroom_stubs under stubs, <out>/../stubs/toolroom_stubs by default, a search path the docs build adds for its renderer. Tools are ordered alphabetically. With nav, the Tools nav block is emitted into that generated tree too, so the sidebar can never fall behind the drivers again.

fm toolroom.pages <out> [--nav=PATH] [--stubs=PATH]
Parameter Type Default Description
<out> path required directory to write the reference pages into
--nav=PATH path the generated docs tree to emit the Tools nav block into
--stubs=PATH path directory to render the pages' stubs into

Example

$ fm toolroom.pages <out>