sphinx.ext.autodoc.TypeVarMixin

class documentation

class TypeVarMixin(DataDocumenterMixinBase):

Known subclasses: sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.DataDocumenter

View In Hierarchy

Mixin for DataDocumenter and AttributeDocumenter to provide the feature for supporting TypeVars.
Method get​_doc Undocumented
Method should​_suppress​_directive​_header Check directive header should be suppressed.
Method update​_content Update docstring for the NewType object.

Inherited from DataDocumenterMixinBase:

Method should​_suppress​_value​_header Check :value: header should be suppressed.
Class Variable config Undocumented
Class Variable env Undocumented
Class Variable modname Undocumented
Class Variable object Undocumented
Class Variable objpath Undocumented
Class Variable parent Undocumented
def get_doc(self, ignore=None):
overridden in sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.DataDocumenter

Undocumented

Parameters
ignore:intUndocumented
Returns
Optional[List[List[str]]]Undocumented
def should_suppress_directive_header(self):
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.should_suppress_directive_header
Check directive header should be suppressed.
Returns
boolUndocumented
def update_content(self, more_content):
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.update_content
Update docstring for the NewType object.
Parameters
more​_content:StringListUndocumented