Module

autodoc.orchestration.extractors

Extraction wrappers for autodoc.

Provides facade functions for extracting documentation from Python, CLI, and OpenAPI sources.

3Functions

Functions

extract_python 3 list[DocElement] ▼
Extract Python API documentation. RFC: rfc-build-performance-optimizations Pha…
def extract_python(site: SiteLike, python_config: dict, cache: Any | None = None) -> list[DocElement]

Extract Python API documentation.

RFC: rfc-build-performance-optimizations Phase 3 Accepts optional cache for AST caching.

Parameters
Name Type Description
site SiteLike

Site instance
python_config dict

Python autodoc configuration
cache Any | None

Optional BuildCache instance for AST caching

Default:None
Returns
list[DocElement]
extract_cli 2 list[DocElement] ▼
Extract CLI documentation.
def extract_cli(site: SiteLike, cli_config: dict) -> list[DocElement]
Parameters
Name Type Description
site SiteLike
cli_config dict
Returns
list[DocElement]
extract_openapi 2 list[DocElement] ▼
Extract OpenAPI documentation.
def extract_openapi(site: SiteLike, openapi_config: dict) -> list[DocElement]
Parameters
Name Type Description
site SiteLike
openapi_config dict
Returns
list[DocElement]