Functions
load_autodoc_config
Load autodoc configuration from config/ directory or bengal.toml.
Loading priority:
1. config/_def…
load_autodoc_config
def load_autodoc_config(config_path: Path | None = None) -> dict[str, Any]Load autodoc configuration from config/ directory or bengal.toml.
Loading priority:
- config/_default/autodoc.yaml (directory-based config)
- bengal.toml (backward compatibility)
- Default configuration
Parameters 1
| Name | Type | Default | Description |
|---|---|---|---|
config_path |
Path | None |
None |
Path to config file or directory (default: auto-detect) |
Returns
Autodoc configuration dict with defaultsdict[str, Any]
—
_merge_autodoc_config
Merge autodoc configuration with defaults.
_merge_autodoc_config
def _merge_autodoc_config(default_config: dict[str, Any], autodoc_config: dict[str, Any]) -> dict[str, Any]Merge autodoc configuration with defaults.
Parameters 2
| Name | Type | Default | Description |
|---|---|---|---|
default_config |
dict[str, Any] |
— | Default configuration |
autodoc_config |
dict[str, Any] |
— | User autodoc configuration |
Returns
Merged configurationdict[str, Any]
—
get_python_config
Get Python autodoc configuration.
get_python_config
def get_python_config(config: dict[str, Any]) -> dict[str, Any]Get Python autodoc configuration.
Parameters 1
| Name | Type | Default | Description |
|---|---|---|---|
config |
dict[str, Any] |
— |
Returns
dict[str, Any]
get_openapi_config
Get OpenAPI autodoc configuration.
get_openapi_config
def get_openapi_config(config: dict[str, Any]) -> dict[str, Any]Get OpenAPI autodoc configuration.
Parameters 1
| Name | Type | Default | Description |
|---|---|---|---|
config |
dict[str, Any] |
— |
Returns
dict[str, Any]
get_cli_config
Get CLI autodoc configuration.
get_cli_config
def get_cli_config(config: dict[str, Any]) -> dict[str, Any]Get CLI autodoc configuration.
Parameters 1
| Name | Type | Default | Description |
|---|---|---|---|
config |
dict[str, Any] |
— |
Returns
dict[str, Any]
get_grouping_config
Get grouping configuration from Python autodoc config.
get_grouping_config
def get_grouping_config(config: dict[str, Any]) -> dict[str, Any]Get grouping configuration from Python autodoc config.
Parameters 1
| Name | Type | Default | Description |
|---|---|---|---|
config |
dict[str, Any] |
— | Full autodoc configuration dict |
Returns
Grouping configuration with mode and prefix_mapdict[str, Any]
—