sphinx.ext.autodoc.GenericAliasMixin

class documentation

class GenericAliasMixin(DataDocumenterMixinBase): (source)

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

View In Hierarchy

Mixin for DataDocumenter and AttributeDocumenter to provide the feature for supporting GenericAliases.

Method should_suppress_directive_header Check directive header should be suppressed.
Method update_content Update docstring, for example with TypeVar variance.

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 should_suppress_directive_header(self): (source)
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.should_suppress_directive_header

Check directive header should be suppressed.

Returns
boolUndocumented
def update_content(self, more_content): (source)
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.update_content

Update docstring, for example with TypeVar variance.

Parameters
more_content:StringListUndocumented