{Module Name} — API Reference
Version: {version} Generated: {date}
Table of Contents
Overview
{Brief description of the module's purpose and main use cases.}
Classes
{ClassName}
{Class docstring — summary + extended description.}
Attributes:
| Attribute | Type | Description |
|---|---|---|
| {name} | {type} | {description} |
Methods:
{method_name}({params}) -> {return_type}
{Method docstring.}
Functions
{function_name}({params}) -> {return_type}
{Function docstring with Args, Returns, Raises, Example.}
Constants
| Constant | Type | Value | Description |
|---|---|---|---|
| {NAME} | {type} | {value} | {description} |