sphinx.ext.autodoc.DataDocumenter

class documentation

class DataDocumenter(GenericAliasMixin, UninitializedGlobalVariableMixin, ModuleLevelDocumenter): (source)

View In Hierarchy

Specialized Documenter subclass for data items.

Class Method can_document_member Called to see if a member can be documented by this Documenter.
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_doc Decode and return lines of the docstring(s) for the object.
Method get_module_comment Undocumented
Method get_real_modname Get the real module name of an object to document.
Method import_object Import the object given by *self.modname* and *self.objpath* and set it as *self.object*.
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

Inherited from GenericAliasMixin:

Method should_suppress_directive_header Check directive header should be suppressed.
Method update_content Update docstring, for example with TypeVar variance.

Inherited from DataDocumenterMixinBase (via GenericAliasMixin, UninitializedGlobalVariableMixin):

Class Variable config Undocumented
Class Variable env Undocumented
Class Variable modname Undocumented
Class Variable object Undocumented
Class Variable objpath Undocumented
Class Variable parent Undocumented

Inherited from ModuleLevelDocumenter (via GenericAliasMixin, UninitializedGlobalVariableMixin, DataDocumenterMixinBase):

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 GenericAliasMixin, UninitializedGlobalVariableMixin, DataDocumenterMixinBase, ModuleLevelDocumenter):

Method __init__ 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 directive Undocumented
Instance Variable fullname Undocumented
Instance Variable indent Undocumented
Instance Variable module Undocumented
Instance Variable name Undocumented
Instance Variable object_name Undocumented
Instance Variable options Undocumented
Instance Variable real_modname Undocumented
Instance Variable retann Undocumented
Property documenters Returns registered Documenter classes
Method _call_format_args Undocumented
@classmethod
def can_document_member(cls, member, membername, isattr, parent): (source)
overrides sphinx.ext.autodoc.Documenter.can_document_member

Called to see if a member can be documented by this Documenter.

Parameters
member:AnyUndocumented
membername:strUndocumented
isattr:boolUndocumented
parent:AnyUndocumented
Returns
boolUndocumented
def add_content(self, more_content): (source)
overrides sphinx.ext.autodoc.Documenter.add_content

Add content from docstrings, attribute documentation and user.

Parameters
more_content:StringList|NoneUndocumented
def add_directive_header(self, sig): (source)
overrides sphinx.ext.autodoc.Documenter.add_directive_header

Add the directive header and options to the generated content.

Parameters
sig:strUndocumented
def document_members(self, all_members=False): (source)
overrides sphinx.ext.autodoc.Documenter.document_members

Generate reST for member documentation. If *all_members* is True, document all members, else those given by *self.options.members*.

Parameters
all_members:boolUndocumented
def get_doc(self): (source)
overrides sphinx.ext.autodoc.UninitializedGlobalVariableMixin.get_doc

Decode and return lines of the docstring(s) for the object. When it returns None, autodoc-process-docstring will not be called for this object.

Returns
list[list[str]]|NoneUndocumented
def get_module_comment(self, attrname): (source)

Undocumented

Parameters
attrname:strUndocumented
Returns
list[str]|NoneUndocumented
def get_real_modname(self): (source)
overrides sphinx.ext.autodoc.Documenter.get_real_modname

Get the real module name of an object to document. It can differ from the name of the module through which the object was imported.

Returns
strUndocumented
def import_object(self, raiseerror=False): (source)
overrides sphinx.ext.autodoc.UninitializedGlobalVariableMixin.import_object

Import the object given by *self.modname* and *self.objpath* and set it as *self.object*. Returns True if successful, False if an error occurred.

Parameters
raiseerror:boolUndocumented
Returns
boolUndocumented
def should_suppress_value_header(self): (source)
overrides sphinx.ext.autodoc.UninitializedGlobalVariableMixin.should_suppress_value_header

Check :value: header should be suppressed.

Returns
boolUndocumented
def update_annotations(self, parent): (source)

Update __annotations__ to support type_comment and so on.

Parameters
parent:AnyUndocumented
member_order: int = (source)
overrides sphinx.ext.autodoc.Documenter.member_order

Undocumented

objtype: str = (source)
overrides sphinx.ext.autodoc.Documenter.objtype

Undocumented

option_spec: OptionSpec = (source)
overrides sphinx.ext.autodoc.Documenter.option_spec

Undocumented

priority: int = (source)
overrides sphinx.ext.autodoc.Documenter.priority

Undocumented

analyzer = (source)
overrides sphinx.ext.autodoc.Documenter.analyzer

Undocumented