Python API Reference

The pages under this section are generated from the Google-style docstrings in micboard/ by scripts/generate_api_docs.py, which reads the source statically with Griffe. Nothing is imported at build time, so the documentation build never needs Django settings.

Regenerate the reference after changing a documented module:

just docs-api

Generated reference

• Models — model domains, managers, and querysets
• Services — the typed service layer and its DTOs
• Management Commands — command classes and their options
• WebSocket Consumers — Channels consumers and routing
• Exceptions — the consolidated exception hierarchy

Hand-authored references

• HTTP Endpoints — REST surface and current status
• WebSocket API — message contract and authorization rules
• Python and integration reference — the supported integration surface with worked examples

The curated module list lives in PAGES inside scripts/generate_api_docs.py; add a module there when a new public surface needs to appear in the reference.