sphinx.ext.autodoc.ModuleDocumenter

class documentation

class ModuleDocumenter(Documenter):

Specialized Documenter subclass for modules.

Class Method	`can_document_member`	Called to see if a member can be documented by this Documenter.
Method	`__init__`	Undocumented
Method	`add_directive_header`	Add the directive header and options to the generated content.
Method	`get_module_members`	Get members of target module.
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	`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	`resolve_name`	Resolve the module and name of the object to document given by the arguments and the current module/class.
Method	`sort_members`	Sort the given member list.
Class Variable	`content_indent`	Undocumented
Class Variable	`objtype`	Undocumented
Class Variable	`option_spec`	Undocumented
Class Variable	`titles_allowed`	Undocumented
Instance Variable	`__all__`	Undocumented

Inherited from Documenter:

Method	`_call_format_args`	Undocumented
Method	`add_content`	Add content from docstrings, attribute documentation and user.
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_real_modname`	Get the real module name of an object to document.
Method	`get_sourcename`	Undocumented
Method	`process_doc`	Let the user process the docstrings before adding them.
Class Variable	`member_order`	Undocumented
Class Variable	`priority`	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

@classmethod
def can_document_member(cls, member, membername, isattr, parent):

overrides sphinx.ext.autodoc.Documenter.can_document_member

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

overrides sphinx.ext.autodoc.Documenter.__init__

Undocumented

Parameters
*args:`Any`	Undocumented

def add_directive_header(self, sig):

overrides sphinx.ext.autodoc.Documenter.add_directive_header

Add the directive header and options to the generated content.

Parameters
sig:`str`	Undocumented

def get_module_members(self):

Get members of target module.

Returns
`Dict[str, ObjectMember]`	Undocumented

def get_object_members(self, want_all):

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

Parameters
want_all:`bool`	Undocumented
Returns
`Tuple[bool, ObjectMembers]`	Undocumented

def import_object(self, raiseerror=False):

overrides sphinx.ext.autodoc.Documenter.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:`bool`	Undocumented
Returns
`bool`	Undocumented

def parse_name(self):

overrides sphinx.ext.autodoc.Documenter.parse_name

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.

Returns
`bool`	Undocumented

def resolve_name(self, modname, parents, path, base):

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:`str`	Undocumented
parents:`Any`	Undocumented
path:`str`	Undocumented
base:`Any`	Undocumented
Returns
`Tuple[str, List[str]]`	Undocumented

def sort_members(self, documenters, order):

overrides sphinx.ext.autodoc.Documenter.sort_members

Sort the given member list.

Parameters
documenters:`List[Tuple[Documenter, bool]]`	Undocumented
order:`str`	Undocumented
Returns
`List[Tuple[Documenter, bool]]`	Undocumented

content_indent: str =

overrides sphinx.ext.autodoc.Documenter.content_indent

Undocumented

objtype: str =

overrides sphinx.ext.autodoc.Documenter.objtype

Undocumented

option_spec: OptionSpec =

overrides sphinx.ext.autodoc.Documenter.option_spec

Undocumented

titles_allowed: bool =

overrides sphinx.ext.autodoc.Documenter.titles_allowed

Undocumented

__all__ =

Undocumented