sphinx.domains.python.PyDecoratorMethod

class documentation

class PyDecoratorMethod(PyMethod): (source)

View In Hierarchy

Description of a decoratormethod.

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 Main directive entry function, called by docutils upon encountering the directive.
Instance Variable name Undocumented

Inherited from PyMethod:

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

Method add_target_and_index Add cross-reference IDs and entries to self.indexnode, if applicable.
Method after_content Handle object de-nesting after content
Method before_content Handle object nesting before content
Class Variable allow_nesting Undocumented
Class Variable doc_field_types Undocumented
Method _object_hierarchy_parts Returns a tuple of strings, one entry for each part of the object's hierarchy (e.g. ``('module', 'submodule', 'Class', 'method')``). The returned tuple is used to properly nest children within parents in the table of contents, and can also be used within the :py:meth:`_toc_entry_name` method.
Method _toc_entry_name Returns the text of the table of contents entry for the object.

Inherited from ObjectDescription (via PyMethod, PyObject):

Method get_field_type_map Undocumented
Method get_signatures Retrieve the signatures to document from the directive arguments. By default, signatures are given as arguments, one per line.
Method transform_content Called after creating the content through nested parsing, but before the ``object-description-transform`` event is emitted, and before the info-fields are transformed. Can be used to manipulate the content.
Class Variable final_argument_whitespace Undocumented
Class Variable has_content Undocumented
Class Variable optional_arguments Undocumented
Class Variable required_arguments Undocumented
Instance Variable domain Undocumented
Instance Variable indexnode Undocumented
Instance Variable names Undocumented
Instance Variable objtype Undocumented
Instance Variable _doc_field_type_map Undocumented

Inherited from SphinxDirective (via PyMethod, PyObject, ObjectDescription):

Method get_location Get current location info for logging.
Method get_source_info Get source and line number.
Method set_source_info Set source and line number to the node.
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def handle_signature(self, sig, signode): (source)
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:strUndocumented
signode:desc_signatureUndocumented
Returns
tuple[str, str]Undocumented
def needs_arglist(self): (source)
overrides sphinx.domains.python.PyMethod.needs_arglist

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

Returns
boolUndocumented
def run(self): (source)
overrides sphinx.directives.ObjectDescription.run

Main directive entry function, called by docutils upon encountering the directive. This directive is meant to be quite easily subclassable, so it delegates to several additional methods. What it does: * find out if called as a domain-specific directive, set self.domain * create a `desc` node to fit all description inside * parse standard options, currently `noindex` * create an index node if needed as self.indexnode * parse all given signatures (as returned by self.get_signatures()) using self.handle_signature(), which should either return a name or raise ValueError * add index entries using self.add_target_and_index() * parse the content and handle doc fields in it

Returns
list[Node]Undocumented
name: str = (source)

Undocumented