8.5.11. 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. The same text is used as the introduction of the module documentation.

pymodaq_utils.help.get_help_text(obj)

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 help.md in the folder of the file defining the object.

Returns:

The markdown text, None if no help file is found.

Return type:

Optional[str]