Documentation
Documentation is built with mdBook.
srb doc (alias srb docs) — Local Preview
srb doc (alias srb docs) groups documentation commands and defaults to serve.
| Sub-subcommand | Description |
|---|---|
srb doc serve (default) | Run an mdBook live-reload server (default action) |
srb doc build | Build the static documentation site for local preview |
srb doc docgen | Regenerate auto-introspected pages (assets, tasks, catalogs) — launches Isaac Sim headless |
srb doc thumbnail | Render asset thumbnails into docs/src/_graphics/assets/ or task thumbnails into docs/src/_graphics/tasks/ |
srb doc serve
srb doc build
srb doc docgen --static-only
srb doc thumbnail --asset-type robot
srb doc thumbnail --task excavation_demo
srb doc thumbnail --task ALL
docgen regenerates the asset, task, compatibility, action-space, sensor, stats, and attribution pages. It launches Isaac Sim headless for introspection. --assets-only and --tasks-only scope which pages are written.
--static-only checks the schema version of docs/data/assets.toml and docs/data/tasks.toml, the types of their known sidecar fields (unknown keys are ignored), and task GUI themes and ranks. It exits nonzero on any error. On success, it prints the asset/task counts without launching anything or writing any page, so it can run where Isaac Sim is unavailable. It cannot check that a sidecar entry names a registered asset or task; only the simulator-backed run does that.
Hand-written sections stay intact between runs when wrapped in <!-- PRESERVE:<key> --> … <!-- /PRESERVE:<key> --> markers.
thumbnail accepts --width, --height, --output-dir, --asset, --asset-type, --task, --force, and --allow-failures (keep a task batch going even when some tasks fail). By default, asset and task thumbnails go to docs/src/_graphics/assets/ and docs/src/_graphics/tasks/; --output-dir overrides the destination. After task thumbnails render, it republishes the current offline cache generation with a rebuilt GUI catalog. Any catalog refresh exception is logged as a warning.
Hint:
srb doc serveandsrb doc buildforward any tokens after--directly tomdbook.