Reference¶
Reference pages are exact lookup material. They should avoid narrative and focus on stable facts.
Available reference material¶
- API reference, generated from package docstrings by mkdocstrings during the MkDocs build.
- Compatibility, covering supported Python versions and API compatibility expectations.
- Configuration and automation, covering local development commands and generated artifacts.
Use tutorials and how-to guides when learning a workflow. Use this section when checking names, options, and support boundaries.