8.5.10. pymodaq_utils.help module
Contextual help of the PyMoDAQ modules.
By convention, the help of a module (control module, manager, extension…) is a short markdown text stored in a file
named help.md in the same folder as the python file defining the module. A module defined by a single file that
shares its folder with other modules (the Dashboard, the Console…) uses a file named after it instead:
<name of the python file>.help.md (dashboard.help.md next to dashboard.py). The same text is used as the
introduction of the module documentation.
- pymodaq_utils.help.get_help_text(obj)[source]
Get the markdown help text associated with a module, a class or an object
- Parameters:
obj (
Union[type,object,ModuleType,str,Path]) – A class, an instance, a python module, or the path of a file (or a folder) from which the help is looked for. The help file is<file name>.help.md(for instancedashboard.help.md) or, if it does not exist,help.md, in the folder of the file defining the object.- Returns:
The markdown text, None if no help file is found.
- Return type: