SubsectionDocumenter

class SubsectionDocumenter(directive, name, indent='')

Bases: AttributeDocumenter

Document for subsections.

Parameters:

• directive (DocumenterBridge)

• name (str)

• indent (str)

get_doc()

Decode and return lines of the docstring(s) for the object.

When it returns None, autodoc-process-docstring will not be called for this object.

Return type:

list[list[str]]

objtype = 'subsection'

name by which the directive is called (auto…) and the default generated directive name