Skip to content

main ¤

Main function of the program.

Functions:

prepare_context ¤

prepare_context(
    obj: Object, config: dict | None = None
) -> dict

Prepare Jinja context.

Parameters:

  • obj (Object) –

    A Griffe object.

  • config (dict | None, default: None ) –

    The configuration options.

Returns:

  • dict –

    The Jinja context.

prepare_env ¤

prepare_env(env: Environment | None = None) -> Environment

Prepare Jinja environment.

Parameters:

  • env (Environment | None, default: None ) –

    A Jinja environment.

Returns:

  • Environment –

    The Jinja environment.

render_object_docs ¤

render_object_docs(
    obj: Object, config: dict | None = None
) -> str

Render docs for a given object.

Parameters:

  • obj (Object) –

    The Griffe object to render docs for.

  • config (dict | None, default: None ) –

    The rendering configuration.

Returns:

  • str –

    Markdown.

render_package_docs ¤

render_package_docs(
    package: str, config: dict | None = None
) -> str

Render docs for a given package.

Parameters:

  • package (str) –

    The package (name) to render docs for.

  • config (dict | None, default: None ) –

    The rendering configuration.

Returns:

  • str –

    Markdown.

write_package_docs ¤

write_package_docs(
    package: str,
    config: dict | None = None,
    output: IO | str | None = None,
) -> None

Write docs for a given package to a file or stdout.

Parameters:

  • package (str) –

    The package to render docs for.

  • config (dict | None, default: None ) –

    The rendering configuration.

  • output (IO | str | None, default: None ) –

    The file to write to.