sphinx.ext.autodoc.Documenter

Undocumented

Add content from docstrings, attribute documentation and user.

Add the directive header and options to the generated content.

Append one line of generated reST to the output.

Check if *self.object* is really defined in the module given by *self.modname*.

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

Filter the given member list. Members are skipped if - they are private (except if given explicitly or the private-members option is set) - they are special methods (except if given explicitly or the special-members option is set) - they are undocumented (except if the undoc-members option is set) The user can override the skipping decision by connecting to the ``autodoc-skip-member`` event.

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

Format the name of *self.object*. This normally should be something that can be parsed by the generated directive, but doesn't need to be (Sphinx will display it unparsed then).

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

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.

getattr() override for types such as Zope interfaces.

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.

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).

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.

Undocumented

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.

Determine what module to import and what attribute to document. Returns True and sets *self.modname*, *self.objpath*, *self.fullname*, *self.args* and *self.retann* if parsing and resolving was successful.

Let the user process the docstrings before adding them.

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.

Sort the given member list.