sphinx.domains.python.PyDecoratorFunction

class documentation

class PyDecoratorFunction(PyFunction):

Description of a decorator.

Method	`handle_signature`	Transform a Python signature into RST nodes.
Method	`needs_arglist`	May return true if an empty argument list is to be generated even if the document contains none.
Method	`run`	Undocumented
Instance Variable	`name`	Undocumented

Inherited from PyFunction:

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.
Class Variable	`option_spec`	Undocumented

Inherited from PyObject (via PyFunction):

Method	`after_content`	Handle object de-nesting after content
Method	`before_content`	Handle object nesting before content
Class Variable	`allow_nesting`	Class is an object that allows for nested namespaces
Class Variable	`doc_field_types`	Undocumented

def handle_signature(self, sig, signode):

overrides sphinx.domains.python.PyObject.handle_signature

Transform a Python signature into RST nodes.

Return (fully qualified name of the thing, classname if any).

If inside a class, the current class name is handled intelligently: * it is stripped from the displayed name if present * it is added to the full name (return value) if not present

Parameters
sig:`str`	Undocumented
signode:`desc_signature`	Undocumented
Returns
`Tuple[str, str]`	Undocumented

def needs_arglist(self):

overrides sphinx.domains.python.PyFunction.needs_arglist

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

Returns
`bool`	Undocumented

def run(self):

Undocumented

Returns
`List[Node]`	Undocumented

name: str =

Undocumented