sphinx.ext.autodoc.RuntimeInstanceAttributeMixin

class documentation

class RuntimeInstanceAttributeMixin(DataDocumenterMixinBase): (source)

Known subclasses: sphinx.ext.autodoc.AttributeDocumenter

View In Hierarchy

Mixin for AttributeDocumenter to provide the feature for supporting runtime instance attributes (that are defined in __init__() methods with doc-comments). Example: class Foo: def __init__(self): self.attr = None #: This is a target of this mix-in.

Method get_doc Undocumented
Method import_object Check the existence of runtime instance attribute after failing to import the attribute.
Method is_runtime_instance_attribute Check the subject is an attribute defined in __init__().
Method is_runtime_instance_attribute_not_commented Check the subject is an attribute defined in __init__() without comment.
Method should_suppress_value_header Check :value: header should be suppressed.
Constant RUNTIME_INSTANCE_ATTRIBUTE 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 object 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

Check the existence of runtime instance attribute after failing to import the attribute.

Parameters
raiseerror:boolUndocumented
Returns
boolUndocumented
def is_runtime_instance_attribute(self, parent): (source)

Check the subject is an attribute defined in __init__().

Parameters
parent:AnyUndocumented
Returns
boolUndocumented
def is_runtime_instance_attribute_not_commented(self, parent): (source)

Check the subject is an attribute defined in __init__() without comment.

Parameters
parent:AnyUndocumented
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
RUNTIME_INSTANCE_ATTRIBUTE = (source)

Undocumented

Value
object()