class documentation
Description of an attribute.
Method | get |
Return the text for the index entry of the object. |
Method | handle |
Transform a Python signature into RST nodes. |
Class Variable | option |
Undocumented |
Inherited from PyObject
:
Method | add |
Add cross-reference IDs and entries to self.indexnode, if applicable. |
Method | after |
Handle object de-nesting after content |
Method | before |
Handle object nesting before content |
Method | get |
May return a prefix to put before the object name in the signature. |
Method | needs |
May return true if an empty argument list is to be generated even if the document contains none. |
Class Variable | allow |
Undocumented |
Class Variable | doc |
Undocumented |
Method | _object |
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 |
Returns the text of the table of contents entry for the object. |
Inherited from ObjectDescription
(via PyObject
):
Method | get |
Undocumented |
Method | get |
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 |
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 |
Undocumented |
Class Variable | has |
Undocumented |
Class Variable | optional |
Undocumented |
Class Variable | required |
Undocumented |
Instance Variable | domain |
Undocumented |
Instance Variable | indexnode |
Undocumented |
Instance Variable | names |
Undocumented |
Instance Variable | objtype |
Undocumented |
Instance Variable | _doc |
Undocumented |
Inherited from SphinxDirective
(via PyObject
, ObjectDescription
):
Method | get |
Get current location info for logging. |
Method | get |
Get source and line number. |
Method | set |
Set source and line number to the node. |
Property | config |
Reference to the :class:`.Config` object. |
Property | env |
Reference to the :class:`.BuildEnvironment` object. |
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[ | Undocumented |