python ¤
Python handler for mkdocstrings.
Modules:
-
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(
*,
theme: str,
custom_templates: str | None = None,
config_file_path: str | None = None,
paths: list[str] | None = None,
locale: str = "en",
load_external_modules: bool = False,
**config: Any
) -> PythonHandler
Simply return an instance of PythonHandler
.
Parameters:
-
theme
¤str
) –The theme to use when rendering contents.
-
custom_templates
¤str | None
, default:None
) –Directory containing custom templates.
-
config_file_path
¤str | None
, default:None
) –The MkDocs configuration file path.
-
paths
¤list[str] | None
, default:None
) –A list of paths to use as Griffe search paths.
-
locale
¤str
, default:'en'
) –The locale to use when rendering content.
-
load_external_modules
¤bool
, default:False
) –Load external modules when resolving aliases.
-
**config
¤Any
, default:{}
) –Configuration passed to the handler.
Returns:
-
PythonHandler
–An instance of
PythonHandler
.