Note
This page is a reference documentation. It only explains the function signature, and not how to use it. Please refer to the user guide for the big picture.
pysphinxdoc.utils._getmembers¶
- pysphinxdoc.utils._getmembers(module, visited, root_module=None)[source]¶
Return the members of a module, and try to apply the selection defined in the ‘__all__’ attribute.
- Parameters:
- mod: ModuleType
a module.
- visited: set
a list of already visited modules.
- root_module: ModuleType, default None
the root module used to not go too deep.
- Returns:
- members: dict
structure containing the module names as keys and the asssociated classes and functions names.