Skip to content

python ¤

Python handler for mkdocstrings.

Modules:

  • config

    Configuration and options dataclasses.

  • debug

    Debugging utilities.

  • handler

    This module implements a handler for the Python language.

  • rendering

    This module implements rendering utilities.

Functions:

  • get_handler

    Simply return an instance of PythonHandler.

get_handler ¤

get_handler(
    handler_config: MutableMapping[str, Any],
    tool_config: MkDocsConfig,
    **kwargs: Any
) -> PythonHandler

Simply return an instance of PythonHandler.

Parameters:

  • handler_config ¤

    (MutableMapping[str, Any]) –

    The handler configuration.

  • tool_config ¤

    (MkDocsConfig) –

    The tool (SSG) configuration.

Returns: