API Reference¶
The reference section is generated from Python docstrings using mkdocstrings. Update docstrings when you change public behavior; regenerate by running mkdocs build -f docs/mkdocs.yml.
Adding new modules¶
- Create a Markdown file under
docs/reference/withpackage.moduleblocks. - Link it from
navindocs/mkdocs.yml. - Keep docstrings consistent (see
contributing/docs-style.md).