sphinx.ext.autodoc.FunctionDocumenter

class documentation

class FunctionDocumenter(DocstringSignatureMixin, ModuleLevelDocumenter):

Known subclasses: sphinx.ext.autodoc.DecoratorDocumenter, sphinx.ext.autodoc.deprecated.SingledispatchFunctionDocumenter

View In Hierarchy

Specialized Documenter subclass for functions.

Class Method	`can_document_member`	Called to see if a member can be documented by this Documenter.
Method	`add_directive_header`	Add the directive header and options to the generated content.
Method	`annotate_to_first_argument`	Annotate type hint to the first argument of function if needed.
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	`merge_default_value`	Merge default values of actual implementation to the overload variants.
Class Variable	`member_order`	Undocumented
Class Variable	`objtype`	Undocumented

Inherited from DocstringSignatureMixin:

Method	`_find_signature`	Undocumented
Method	`get_doc`	Undocumented
Instance Variable	`_new_docstrings`	Undocumented
Instance Variable	`_signatures`	Undocumented
Instance Variable	`args`	Undocumented
Instance Variable	`retann`	Undocumented

Inherited from ModuleLevelDocumenter:

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

Method	`__init__`	Undocumented
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	`filter_members`	Filter the given member list.
Method	`format_name`	Format the name of self.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	`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

@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 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 annotate_to_first_argument(self, func, typ):

Annotate type hint to the first argument of function if needed.

Parameters
func:`Callable`	Undocumented
typ:`Type`	Undocumented
Returns
`Optional[Callable]`	Undocumented

def document_members(self, all_members=False):

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

overrides sphinx.ext.autodoc.Documenter.format_args

overridden in sphinx.ext.autodoc.DecoratorDocumenter

Format the argument signature of self.object.

Should return None if the object does not have a signature.

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

def format_signature(self, **kwargs):

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 merge_default_value(self, actual, overload):

Merge default values of actual implementation to the overload variants.

Parameters
actual:`Signature`	Undocumented
overload:`Signature`	Undocumented
Returns
`Signature`	Undocumented

member_order: int =

overrides sphinx.ext.autodoc.Documenter.member_order

Undocumented

objtype: str =

overrides sphinx.ext.autodoc.Documenter.objtype

overridden in sphinx.ext.autodoc.DecoratorDocumenter

Undocumented