sphinx.ext.autodoc.NonDataDescriptorMixin

class documentation

class NonDataDescriptorMixin(DataDocumenterMixinBase):

Mixin for AttributeDocumenter to provide the feature for supporting non data-descriptors.

Note

This mix-in must be inherited after other mix-ins. Otherwise, docstring and :value: header will be suppressed unexpectedly.

Method	`get_doc`	Undocumented
Method	`import_object`	Undocumented
Method	`should_suppress_value_header`	Check :value: header should be suppressed.
Instance Variable	`non_data_descriptor`	Undocumented

Method	`should_suppress_directive_header`	Check directive 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 get_doc(self, ignore=None):

overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

def import_object(self, raiseerror=False):

overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

def should_suppress_value_header(self):

overrides sphinx.ext.autodoc.DataDocumenterMixinBase.should_suppress_value_header

overridden in sphinx.ext.autodoc.AttributeDocumenter

Check :value: header should be suppressed.

Returns
`bool`	Undocumented

non_data_descriptor: bool =

Undocumented