sphinx.ext.autodoc.ClassDocumenter

class documentation

class ClassDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter): (source)

Known subclasses: sphinx.ext.autodoc.ExceptionDocumenter

Specialized Documenter subclass for classes.

Class Method	`can_document_member`	Called to see if a member can be documented by this Documenter.
Method	`__init__`	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	`format_args`	Format the argument signature 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_canonical_fullname`	Undocumented
Method	`get_doc`	Decode and return lines of the docstring(s) for the object.
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_overloaded_signatures`	Undocumented
Method	`get_variable_comment`	Undocumented
Method	`import_object`	Import the object given by self.modname and self.objpath and set it as self.object.
Class Variable	`member_order`	Undocumented
Class Variable	`objtype`	Undocumented
Class Variable	`option_spec`	Undocumented
Class Variable	`priority`	Undocumented
Instance Variable	`analyzer`	Undocumented
Instance Variable	`directivetype`	Undocumented
Instance Variable	`doc_as_attr`	Undocumented
Instance Variable	`modname`	Undocumented
Instance Variable	`objpath`	Undocumented
Instance Variable	`options`	Undocumented
Method	`_find_signature`	Undocumented
Method	`_get_signature`	Undocumented
Instance Variable	`_signature_class`	Undocumented
Instance Variable	`_signature_method_name`	Undocumented

Inherited from DocstringSignatureMixin:

Instance Variable	`args`	Undocumented
Instance Variable	`retann`	Undocumented
Instance Variable	`_new_docstrings`	Undocumented
Instance Variable	`_signatures`	Undocumented

Inherited from ModuleLevelDocumenter (via DocstringSignatureMixin):

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 DocstringSignatureMixin, ModuleLevelDocumenter):

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_name`	Format the name of self.object.
Method	`get_attr`	getattr() override for types such as Zope interfaces.
Method	`get_real_modname`	Get the real module name of an object to document.
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	`config`	Undocumented
Instance Variable	`directive`	Undocumented
Instance Variable	`env`	Undocumented
Instance Variable	`fullname`	Undocumented
Instance Variable	`indent`	Undocumented
Instance Variable	`module`	Undocumented
Instance Variable	`name`	Undocumented
Instance Variable	`object`	Undocumented
Instance Variable	`object_name`	Undocumented
Instance Variable	`parent`	Undocumented
Instance Variable	`real_modname`	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

overridden in sphinx.ext.autodoc.ExceptionDocumenter

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

Parameters
member:`Any`	Undocumented
membername:`str`	Undocumented
isattr:`bool`	Undocumented
parent:`Any`	Undocumented
Returns
`bool`	Undocumented

def __init__(self, *args): (source) ¶

overrides sphinx.ext.autodoc.Documenter.__init__

Undocumented

Parameters
*args:`Any`	Undocumented

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\|None`	Undocumented

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:`str`	Undocumented

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:`bool`	Undocumented

def format_args(self, **kwargs): (source) ¶

overrides sphinx.ext.autodoc.Documenter.format_args

Format the argument signature of *self.object*. Should return None if the object does not have a signature.

Parameters
**kwargs:`Any`	Undocumented
Returns
`str\|None`	Undocumented

def format_signature(self, **kwargs): (source) ¶

overrides sphinx.ext.autodoc.DocstringSignatureMixin.format_signature

Format the signature (arguments and return annotation) of the object. Let the user process it via the ``autodoc-process-signature`` event.

Parameters
**kwargs:`Any`	Undocumented
Returns
`str`	Undocumented

def generate(self, more_content=None, real_modname=None, check_module=False, all_members=False): (source) ¶

overrides sphinx.ext.autodoc.Documenter.generate

Generate reST for the object given by *self.name*, and possibly for its members. If *more_content* is given, include that content. If *real_modname* is given, use that module name to find attribute docs. If *check_module* is True, only generate if the object is defined in the module name it is imported from. If *all_members* is True, document all members.

Parameters
more_content:`StringList\|None`	Undocumented
real_modname:`str\|None`	Undocumented
check_module:`bool`	Undocumented
all_members:`bool`	Undocumented

def get_canonical_fullname(self): (source) ¶

Undocumented

Returns
`str\|None`	Undocumented

def get_doc(self): (source) ¶

overrides sphinx.ext.autodoc.DocstringSignatureMixin.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]]\|None`	Undocumented

def get_object_members(self, want_all): (source) ¶

overrides sphinx.ext.autodoc.Documenter.get_object_members

Return `(members_check_module, members)` where `members` is a list of `(membername, member)` pairs of the members of *self.object*. If *want_all* is True, return all members. Else, only return those members given by *self.options.members* (which may also be None).