docs.globals¶
Render the runner's global options as a markdown table.
The rows come straight from the CLI grammar — the same table --help
prints — so a reference page that regenerates this on each docs build
can never drift from the runner. Without --out the table is the task's
stdout; with --out it is written to the file.
| Parameter | Type | Default | Description |
|---|---|---|---|
--out=PATH |
path | file to write the table into; omitted = stdout | |
--prog=VALUE |
"fm" |
command name in the table |
Returns: a list of text (or null)