class documentation
class CAliasObject(ObjectDescription): (source)
Undocumented
Method | run |
On purpose this doesn't call the ObjectDescription version, but is based on it. Each alias signature may expand into multiple real signatures if 'noroot'. The code is therefore based on the ObjectDescription version. |
Class Variable | option |
Undocumented |
Instance Variable | domain |
Undocumented |
Instance Variable | names |
Undocumented |
Instance Variable | objtype |
Undocumented |
Inherited from ObjectDescription
:
Method | add |
Add cross-reference IDs and entries to self.indexnode, if applicable. |
Method | after |
Called after parsing content. Used to reset information about the current directive context on the build environment. |
Method | before |
Called before parsing content. Used to set information about the current directive context on the build environment. |
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 | handle |
Parse the signature *sig* into individual nodes and append them to *signode*. If ValueError is raised, parsing is aborted and the whole *sig* is put into a single desc_name node. |
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 | doc |
Undocumented |
Class Variable | final |
Undocumented |
Class Variable | has |
Undocumented |
Class Variable | optional |
Undocumented |
Class Variable | required |
Undocumented |
Instance Variable | indexnode |
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. |
Instance Variable | _doc |
Undocumented |
Inherited from SphinxDirective
(via 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. |