sphinx.ext.autodoc.SlotsMixin

class documentation

class SlotsMixin(DataDocumenterMixinBase):

Known subclasses: sphinx.ext.autodoc.AttributeDocumenter

View In Hierarchy

Mixin for AttributeDocumenter to provide the feature for supporting __slots__.
Method get​_doc Undocumented
Method import​_object Undocumented
Method isslotsattribute Check the subject is an attribute in __slots__.
Method should​_suppress​_value​_header Check :value: header should be suppressed.
Instance Variable object Undocumented
Property ​_datadescriptor Undocumented

Inherited from DataDocumenterMixinBase:

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 objpath Undocumented
Class Variable parent Undocumented
def get_doc(self, ignore=None):
overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

Parameters
ignore:intUndocumented
Returns
Optional[List[List[str]]]Undocumented
def import_object(self, raiseerror=False):
overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

Parameters
raiseerror:boolUndocumented
Returns
boolUndocumented
def isslotsattribute(self):
Check the subject is an attribute in __slots__.
Returns
boolUndocumented
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
boolUndocumented
object =
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.object
overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

@property
_datadescriptor: bool =

Undocumented