docs¶
Documentation site (Zensical)
| Task | Description |
|---|---|
serve |
Build and serve the docs with live reload. (runs until Ctrl-C) |
coverage |
Generate the coverage HTML report into docs/htmlcov (embedded in the site). |
api |
Generate the API reference from the export table; refuse on drift. |
build |
Build the docs site into ./site; regenerates llms.txt and docs/tasks/. |
page |
Render the task tree (or one group/task) as one markdown page. |
site |
Render the task tree as linked pages: index.md per group, one file per task. |
shots |
Run the CLI on a pseudo-terminal and save a framed SVG screenshot. |
cast |
Record an animated SVG of a real interactive shell session. |
errors |
Render every runtime error and note as a markdown reference page. |
config |
Render this runner's config keys as a markdown table. |
notes |
Render the note kinds as a markdown table. |
globals |
Render the runner's global options as a markdown table. |