sphinx.domains.python.PyVariable

class documentation

class PyVariable(PyObject): (source)

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`	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
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`	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 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	`run`	Main directive entry function, called by docutils upon encountering the directive.
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 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 get_index_text(self, modname, name_cls): (source) ¶

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): (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:`str`	Undocumented
signode:`desc_signature`	Undocumented
Returns
`tuple[str, str]`	Undocumented

option_spec: OptionSpec = (source) ¶

overrides sphinx.domains.python.PyObject.option_spec

Undocumented