sphinx.ext.autodoc.DataDocumenterMixinBase

class documentation

class DataDocumenterMixinBase: (source)

Known subclasses: sphinx.ext.autodoc.GenericAliasMixin, sphinx.ext.autodoc.NonDataDescriptorMixin, sphinx.ext.autodoc.RuntimeInstanceAttributeMixin, sphinx.ext.autodoc.SlotsMixin, sphinx.ext.autodoc.UninitializedGlobalVariableMixin, sphinx.ext.autodoc.UninitializedInstanceAttributeMixin

View In Hierarchy

Undocumented

Method	`should_suppress_directive_header`	Check directive header should be suppressed.
Method	`should_suppress_value_header`	Check :value: header should be suppressed.
Method	`update_content`	Update docstring, for example with TypeVar variance.
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) ¶

overridden in sphinx.ext.autodoc.GenericAliasMixin

Check directive header should be suppressed.

Returns
`bool`	Undocumented

def should_suppress_value_header(self): (source) ¶

overridden in sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.DataDocumenter, sphinx.ext.autodoc.NonDataDescriptorMixin, sphinx.ext.autodoc.RuntimeInstanceAttributeMixin, sphinx.ext.autodoc.SlotsMixin, sphinx.ext.autodoc.UninitializedGlobalVariableMixin, sphinx.ext.autodoc.UninitializedInstanceAttributeMixin

Check :value: header should be suppressed.

Returns
`bool`	Undocumented

def update_content(self, more_content): (source) ¶

overridden in sphinx.ext.autodoc.GenericAliasMixin

Update docstring, for example with TypeVar variance.

Parameters
more_content:`StringList`	Undocumented

config: Config = (source) ¶

Undocumented

env: BuildEnvironment = (source) ¶

Undocumented

modname: str = (source) ¶

Undocumented

object: Any = (source) ¶

overridden in sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.SlotsMixin

Undocumented

objpath: list[str] = (source) ¶

Undocumented

parent: Any = (source) ¶

Undocumented