sphinx.domains.python.PyFunction

class documentation

class PyFunction(PyObject):

Description of a function.

Method	`add_target_and_index`	Undocumented
Method	`get_index_text`	Return the text for the index entry of the object.
Method	`get_signature_prefix`	May return a prefix to put before the object name in the signature.
Method	`needs_arglist`	May return true if an empty argument list is to be generated even if the document contains none.
Class Variable	`option_spec`	Undocumented

Inherited from PyObject:

Method	`after_content`	Handle object de-nesting after content
Method	`before_content`	Handle object nesting before content
Method	`handle_signature`	Transform a Python signature into RST nodes.
Class Variable	`allow_nesting`	Class is an object that allows for nested namespaces
Class Variable	`doc_field_types`	Undocumented

def add_target_and_index(self, name_cls, sig, signode):

overrides sphinx.domains.python.PyObject.add_target_and_index

Undocumented

def get_index_text(self, modname, name_cls):

overrides sphinx.domains.python.PyObject.get_index_text

Return the text for the index entry of the object.

def get_signature_prefix(self, sig):

overrides sphinx.domains.python.PyObject.get_signature_prefix

May return a prefix to put before the object name in the signature.

def needs_arglist(self):

overrides sphinx.domains.python.PyObject.needs_arglist

overridden in sphinx.domains.python.PyDecoratorFunction

May return true if an empty argument list is to be generated even if the document contains none.

Returns
`bool`	Undocumented

option_spec: OptionSpec =

overrides sphinx.domains.python.PyObject.option_spec

Undocumented