sphinx.ext.autodoc.RuntimeInstanceAttributeMixin

class documentation

class RuntimeInstanceAttributeMixin(DataDocumenterMixinBase):

Known subclasses: sphinx.ext.autodoc.AttributeDocumenter

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.

Constant	`RUNTIME_INSTANCE_ATTRIBUTE`	Undocumented
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.
Instance Variable	`object`	Undocumented
Instance Variable	`parent`	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

RUNTIME_INSTANCE_ATTRIBUTE =

Undocumented

Value

object()

def get_doc(self, ignore=None):

overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

Parameters
ignore:`int`	Undocumented
Returns
`Optional[List[List[str]]]`	Undocumented

def import_object(self, raiseerror=False):

overridden in sphinx.ext.autodoc.AttributeDocumenter

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

Parameters
raiseerror:`bool`	Undocumented
Returns
`bool`	Undocumented

def is_runtime_instance_attribute(self, parent):

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

Parameters
parent:`Any`	Undocumented
Returns
`bool`	Undocumented

def is_runtime_instance_attribute_not_commented(self, parent):

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

Parameters
parent:`Any`	Undocumented
Returns
`bool`	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

object =

overrides sphinx.ext.autodoc.DataDocumenterMixinBase.object

overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented

parent =

overrides sphinx.ext.autodoc.DataDocumenterMixinBase.parent

overridden in sphinx.ext.autodoc.AttributeDocumenter

Undocumented