Skip to content

shell ¤

Shell handler for mkdocstrings.

Modules:

  • debug –

    Debugging utilities.

  • handler –

    This module implements a handler for the Shell language.

Functions:

  • get_handler –

    Simply return an instance of ShellHandler.

get_handler ¤

get_handler(
    theme: str,
    custom_templates: str | None = None,
    config_file_path: str | None = None,
    **config: Any,
) -> ShellHandler

Simply return an instance of ShellHandler.

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.

  • **config (Any, default: {} ) –

    Configuration passed to the handler.

Returns: