sphinx.ext.autodoc.AttributeDocumenter

Class Method	can​_document​_member	Called to see if a member can be documented by this Documenter.
Static Method	is​_function​_or​_method	Undocumented
Method	add​_content	Add content from docstrings, attribute documentation and user.
Method	add​_directive​_header	Add the directive header and options to the generated content.
Method	document​_members	Generate reST for member documentation.
Method	get​_attribute​_comment	Undocumented
Method	get​_doc	Decode and return lines of the docstring(s) for the object.
Method	get​_real​_modname	Get the real module name of an object to document.
Method	import​_object	Check the existence of runtime instance attribute after failing to import the attribute.
Method	isinstanceattribute	Check the subject is an instance attribute.
Method	should​_suppress​_value​_header	Check :value: header should be suppressed.
Method	update​_annotations	Update __annotations__ to support type_comment and so on.
Class Variable	member​_order	Undocumented
Class Variable	objtype	Undocumented
Class Variable	option​_spec	Undocumented
Class Variable	priority	Undocumented
Instance Variable	analyzer	Undocumented
Instance Variable	object	Undocumented
Instance Variable	parent	Undocumented

Inherited from GenericAliasMixin:

Method	should​_suppress​_directive​_header	Check directive header should be suppressed.
Method	update​_content	Update docstring for the NewType object.

Inherited from DataDocumenterMixinBase (via GenericAliasMixin):

Class Variable	config	Undocumented
Class Variable	env	Undocumented
Class Variable	modname	Undocumented
Class Variable	objpath	Undocumented

Inherited from NewTypeMixin:

Method	should​_suppress​_directive​_header	Check directive header should be suppressed.
Method	update​_content	Update docstring for the NewType object.

Inherited from DataDocumenterMixinBase (via NewTypeMixin):

Class Variable	config	Undocumented
Class Variable	env	Undocumented
Class Variable	modname	Undocumented
Class Variable	objpath	Undocumented

Inherited from SlotsMixin:

Method	isslotsattribute	Check the subject is an attribute in __slots__.
Property	​_datadescriptor	Undocumented

Inherited from DataDocumenterMixinBase (via SlotsMixin):

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

Inherited from TypeVarMixin:

Method	should​_suppress​_directive​_header	Check directive header should be suppressed.
Method	update​_content	Update docstring for the NewType object.

Inherited from DataDocumenterMixinBase (via TypeVarMixin):

Class Variable	config	Undocumented
Class Variable	env	Undocumented
Class Variable	modname	Undocumented
Class Variable	objpath	Undocumented

Inherited from RuntimeInstanceAttributeMixin:

Constant	RUNTIME​_INSTANCE​_ATTRIBUTE	Undocumented
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.

Inherited from DataDocumenterMixinBase (via RuntimeInstanceAttributeMixin):

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

Inherited from UninitializedInstanceAttributeMixin:

Method

is​_uninitialized​_instance​_attribute

Check the subject is an annotation only attribute.

Inherited from DataDocumenterMixinBase (via UninitializedInstanceAttributeMixin):

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

Inherited from NonDataDescriptorMixin:

Instance Variable

non​_data​_descriptor

Undocumented

Inherited from DataDocumenterMixinBase (via NonDataDescriptorMixin):

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

Inherited from DocstringStripSignatureMixin:

Method	format​_signature	Undocumented
Instance Variable	retann	Undocumented

Inherited from DocstringSignatureMixin (via DocstringStripSignatureMixin):

Method	​_find​_signature	Undocumented
Instance Variable	​_new​_docstrings	Undocumented
Instance Variable	​_signatures	Undocumented
Instance Variable	args	Undocumented

Inherited from ClassLevelDocumenter:

Method

resolve​_name

Resolve the module and name of the object to document given by the arguments and the current module/class.

Inherited from Documenter (via ClassLevelDocumenter):

Method	__init__	Undocumented
Method	​_call​_format​_args	Undocumented
Method	add​_line	Append one line of generated reST to the output.
Method	check​_module	Check if self.object is really defined in the module given by self.modname.
Method	filter​_members	Filter the given member list.
Method	format​_args	Format the argument signature of self.object.
Method	format​_name	Format the name of self.object.
Method	format​_signature	Format the signature (arguments and return annotation) of the object.
Method	generate	Generate reST for the object given by self.name, and possibly for its members.
Method	get​_attr	getattr() override for types such as Zope interfaces.
Method	get​_object​_members	Return (members_check_module, members) where members is a list of (membername, member) pairs of the members of self.object.
Method	get​_sourcename	Undocumented
Method	parse​_name	Determine what module to import and what attribute to document.
Method	process​_doc	Let the user process the docstrings before adding them.
Method	sort​_members	Sort the given member list.
Class Variable	content​_indent	Undocumented
Class Variable	titles​_allowed	Undocumented
Instance Variable	args	Undocumented
Instance Variable	config	Undocumented
Instance Variable	directive	Undocumented
Instance Variable	env	Undocumented
Instance Variable	fullname	Undocumented
Instance Variable	indent	Undocumented
Instance Variable	modname	Undocumented
Instance Variable	module	Undocumented
Instance Variable	name	Undocumented
Instance Variable	object​_name	Undocumented
Instance Variable	objpath	Undocumented
Instance Variable	options	Undocumented
Instance Variable	real​_modname	Undocumented
Instance Variable	retann	Undocumented
Property	documenters	Returns registered Documenter classes