parse_module_doc
FunctionSource
v_1: DocModule = parse_module_doc(module: ModuleType)
Parse the docstring of a package or a module.
Arguments
Requires
| Name | Type | Required | |
|---|---|---|---|
module | ModuleType | A package/module object to be parsed. |
Returns
| Name | Type | |
|---|---|---|
v_1 | DocModule | The parsed docstring of the module. Note that the members of the module is not parsed by this method. Use a module walker and the add_member() method of the returned value to complete the module information. |