sphinx.ext.autodoc.ClassLevelDocumenter

class documentation

class ClassLevelDocumenter(Documenter): (source)

Known subclasses: sphinx.ext.autodoc.AttributeDocumenter, sphinx.ext.autodoc.MethodDocumenter, sphinx.ext.autodoc.PropertyDocumenter

View In Hierarchy

Specialized Documenter subclass for objects on class level (methods, attributes).

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:

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 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 document_members Generate reST for member documentation.
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_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_real_modname Get the real module name of an object to document.
Method get_sourcename Undocumented
Method import_object Import the object given by *self.modname* and *self.objpath* and set it as *self.object*.
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 member_order Undocumented
Class Variable objtype Undocumented
Class Variable option_spec Undocumented
Class Variable priority Undocumented
Class Variable titles_allowed Undocumented
Instance Variable analyzer 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 Undocumented
Instance Variable object_name Undocumented
Instance Variable objpath Undocumented
Instance Variable options Undocumented
Instance Variable parent Undocumented
Instance Variable real_modname Undocumented
Instance Variable retann Undocumented
Property documenters Returns registered Documenter classes
Method _call_format_args Undocumented
def resolve_name(self, modname, parents, path, base): (source)
overrides sphinx.ext.autodoc.Documenter.resolve_name

Resolve the module and name of the object to document given by the arguments and the current module/class. Must return a pair of the module name and a chain of attributes; for example, it would return ``('zipfile', ['ZipFile', 'open'])`` for the ``zipfile.ZipFile.open`` method.

Parameters
modname:strUndocumented
parents:AnyUndocumented
path:strUndocumented
base:AnyUndocumented
Returns
tuple[str, list[str]]Undocumented