sphinx.domains.python.PyVariable

class documentation

class PyVariable(PyObject):

Description of a variable.

Method	`get_index_text`	Return the text for the index entry of the object.
Method	`handle_signature`	Transform a Python signature into RST nodes.
Class Variable	`option_spec`	Undocumented

Inherited from PyObject:

Method	`add_target_and_index`	Undocumented
Method	`after_content`	Handle object de-nesting after content
Method	`before_content`	Handle object nesting before content
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	`allow_nesting`	Class is an object that allows for nested namespaces
Class Variable	`doc_field_types`	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.

Parameters
modname:`str`	Undocumented
name_cls:`Tuple[str, str]`	Undocumented
Returns
`str`	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

option_spec: OptionSpec =

overrides sphinx.domains.python.PyObject.option_spec

Undocumented