RenderConfig

class emlib.doctools.RenderConfig(maxwidth=80, fmt='markdown', docfmt='markdown', splitName=True, indentReturns=True, attributesAreHeadings=False, includeInheritedMethods=False, generateClassTOC=True)

Bases: object

A RenderConfig determines how the documentation is rendered

Attributes Summary

attributesAreHeadings	If True, attributes are rendered as headings instead of using bold
docfmt	The format the documentation is written in
fmt	The render format
generateClassTOC	If True, add a TOC to a class definition
includeInheritedMethods	If True, add inherited methods to the documentation of each class
indentReturns	clause
maxwidth	The max width of a line
splitName	Show only the base name for functions/methods

Attributes Documentation

attributesAreHeadings: bool = False

If True, attributes are rendered as headings instead of using bold

docfmt: str = 'markdown'

The format the documentation is written in

fmt: str = 'markdown'

The render format

generateClassTOC: bool = True

If True, add a TOC to a class definition

includeInheritedMethods: bool = False

If True, add inherited methods to the documentation of each class

indentReturns: bool = True

clause

Type:

Indent text in a Returns

maxwidth: int = 80

The max width of a line

splitName: bool = True

Show only the base name for functions/methods