generateDocsForFunctions

emlib.doctools.generateDocsForFunctions(funcs, renderConfig=None, title=None, pretext=None, indentLevel=1)

Collects documentation for multiple functions in one string

Parameters:

• funcs (list[Callable]) – the funcs to parse

• title (Optional[str]) – a title to use before the generated code

• pretext (Optional[str]) – a text between the title and the generated code

• indentLevel – the heading start level

• renderConfig (Optional[RenderConfig]) – a RenderConfig

Return type:

str

Returns:

the generated documentation

Raises:

ParseError if any of the functions fails to be parsed –