Skip to content

API Reference

Reference. Auto-generated from docstrings (mkdocstrings). Every signature is type-annotated; >>> examples in docstrings are run by CI (pytest --doctest-modules), so they are always runnable.

How to read these pages

  • Signatures are rendered separately above each description, with type annotations and links to the types.
  • Docstring sections (Args:, Returns:, Raises:, Examples:) are shown as tables.
  • Doctest examples (>>> blocks) are executed by CI — if one breaks, the build fails, so treat them as the ground truth for usage.