sphinx.ext.autodoc.SlotsMixin

class documentation

class SlotsMixin(DataDocumenterMixinBase): (source)

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

Inherited from DataDocumenterMixinBase:

Method should_suppress_directive_header Check directive 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 objpath Undocumented
Class Variable parent Undocumented
def get_doc(self): (source)
overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

Returns
list[list[str]]|NoneUndocumented
def import_object(self, raiseerror=False): (source)
overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

Parameters
raiseerror:boolUndocumented
Returns
boolUndocumented
def isslotsattribute(self): (source)

Check the subject is an attribute in __slots__.

Returns
boolUndocumented
def should_suppress_value_header(self): (source)
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.should_suppress_value_header
overridden in sphinx.ext.autodoc.AttributeDocumenter

Check :value: header should be suppressed.

Returns
boolUndocumented
object = (source)
overrides sphinx.ext.autodoc.DataDocumenterMixinBase.object
overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented