sphinx.ext.autodoc.DataDocumenterMixinBase

class documentation

class DataDocumenterMixinBase:

Known subclasses: sphinx.ext.autodoc.GenericAliasMixin, sphinx.ext.autodoc.NewTypeMixin, sphinx.ext.autodoc.NonDataDescriptorMixin, sphinx.ext.autodoc.RuntimeInstanceAttributeMixin, sphinx.ext.autodoc.SlotsMixin, sphinx.ext.autodoc.TypeVarMixin, 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 the NewType object.
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):
overridden in sphinx.ext.autodoc.GenericAliasMixin, sphinx.ext.autodoc.NewTypeMixin, sphinx.ext.autodoc.TypeVarMixin
Check directive header should be suppressed.
Returns
boolUndocumented
def should_suppress_value_header(self):
overridden in sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.DataDocumenter, sphinx.ext.autodoc.DataDocumenter, 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
boolUndocumented
def update_content(self, more_content):
overridden in sphinx.ext.autodoc.GenericAliasMixin, sphinx.ext.autodoc.NewTypeMixin, sphinx.ext.autodoc.TypeVarMixin
Update docstring for the NewType object.
Parameters
more​_content:StringListUndocumented
config: Config =

Undocumented

env: BuildEnvironment =

Undocumented

modname: str =

Undocumented

object: Any =
overridden in sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.RuntimeInstanceAttributeMixin, sphinx.ext.autodoc.SlotsMixin, sphinx.ext.autodoc.UninitializedGlobalVariableMixin, sphinx.ext.autodoc.UninitializedInstanceAttributeMixin

Undocumented

objpath: List[str] =

Undocumented

parent: Any =
overridden in sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.RuntimeInstanceAttributeMixin, sphinx.ext.autodoc.UninitializedGlobalVariableMixin, sphinx.ext.autodoc.UninitializedInstanceAttributeMixin

Undocumented