generateDocsForModule

emlib.doctools.generateDocsForModule(module, renderConfig=None, exclude=None, indentLevel=1, grouped=False, title='', includeCustomExceptions=False, toc=True)[source]

Generate documentation for the given module

Parameters:

  • module – the module to generate documentation for

  • renderConfig (Optional[RenderConfig]) – a RenderConfig

  • exclude (Optional[list[str]]) – functions/classes to exclude. A list of regexes

  • indentLevel – heading start level

  • grouped – if True, classes / functions are grouped together. Otherwise, the order of appearance within the source code is used

  • title – if given, it will be used instead of the module name

  • includeCustomExceptions – if True, include user defined exceptions into the documentation

Return type:

str

Returns:

The rendered documentation as a markdown string