Documentation
This documentation is built using mdBook, which creates modern online books from a collection of Markdown files.
srb doc (alias srb docs) — Local Preview
The srb doc (alias srb docs) command groups the documentation utilities. Without a sub-subcommand it falls back to serve, which is the most common entry point during day-to-day development.
| Sub-subcommand | Description |
|---|---|
srb doc serve (default) | Run an mdBook live-reload server (default action) |
srb doc build | Build the static documentation site (used by CI/CD) |
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 # equivalent to `srb doc serve`
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, so it launches Isaac Sim headless for introspection. --assets-only and --tasks-only scope which pages are written. --static-only is different: it validates the sidecar inputs and prints the asset/task counts without launching anything or writing any page, which makes it the check to run where Isaac Sim is unavailable. Hand-written sections stay intact between runs when they are 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).
Hint:
srb doc serveandsrb doc buildforward any tokens after--directly tomdbook.
Automated Deployment
The documentation is automatically deployed to GitHub Pages via GitHub Actions. The deployment process is triggered by pushing to the main branch.
Contributing
Documentation is usually the weakest link in most open-source projects. We would greatly appreciate your help in improving this documentation. If you find any errors or have suggestions for improvements, don’t hesitate to open an issue or a pull request. Thank you in advance!