def root_module(root) -> str

Get the root module name from a path.

Arguments:

• root(str): the root path

Returns:

• the root module name

def path_to_module(root, file) -> str

Convert a path to a module name.

Arguments:

• root(str): the parent directory of the file
• file(str): the module name

Returns:

• the dotted module name

def fixup_reexports(root_module, docs) -> None

Inlines items that are reexported from other modules via 'all' lists.

Arguments:

• root_module(str)
• docs(dict[str, Module])

def run(root_dir, output_dir, summary_output_template) -> None

Run the docstring generator.

Arguments:

• root_dir(str)
• output_dir(str)
• summary_output_template(str | None)