Skip to content

API Reference

The API reference is generated by MrDocs and published at:

Generate it locally with:

# Writes docs/reference by default.
bash scripts/generate-api-documentation

To keep generated reference output under the build tree:

MRDOCS_OUTPUT_DIR=build/docs-scratch/docs/reference \
  bash scripts/generate-api-documentation

Or build the full docs site (API reference + MkDocs) with:

# Keeps all docs output under build/docs-scratch.
DOCS_SCRATCH_DIR=build/docs-scratch bash scripts/build-docs

Default (writes docs/reference and _site):

bash scripts/build-docs