qpydoc API document (0.1.2)

walk_submodules

Yield ModuleInfo for all modules recursively

walk_submodules(
    mod_fname: str,
    module_tree: list[typing.Any]=[],
    on_mod: Optional[Callable[[module, Any], NoneType]]=None,
    on_submod: Optional[Callable[[module, module, Any], NoneType]]=None,
    **kwarg: Any,
)

• mod_fname (str): full name string of parent module
• module_tree (list[Any]): list to collect module tree data
• on_mod (Optional[Callable[[ModuleType, KwArg()], None]]]): callback for a parent module
• on_submod (Optional[Callable[[ModuleType, ModuleType, KwArg()], None]]]): callback for a child submodule
• **kwarg (Any): keyword arguments of on_mod and on_submod callbacks