class documentation

class CAliasObject(ObjectDescription):

View In Hierarchy

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​_spec Undocumented
Instance Variable domain Undocumented
Instance Variable names Undocumented
Instance Variable objtype Undocumented

Inherited from ObjectDescription:

Method add​_target​_and​_index Add cross-reference IDs and entries to self.indexnode, if applicable.
Method after​_content Called after parsing content. Used to reset information about the current directive context on the build environment.
Method before​_content Called before parsing content. Used to set information about the current directive context on the build environment.
Method get​_signatures Retrieve the signatures to document from the directive arguments. By default, signatures are given as arguments, one per line.
Method handle​_signature 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​_content No summary
Method get​_field​_type​_map Undocumented
Class Variable doc​_field​_types Undocumented
Class Variable final​_argument​_whitespace Undocumented
Class Variable has​_content Undocumented
Class Variable optional​_arguments Undocumented
Class Variable required​_arguments Undocumented
Instance Variable ​_doc​_field​_type​_map Undocumented
Instance Variable indexnode Undocumented

Inherited from SphinxDirective (via 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 .Config object.
Property env Reference to the .BuildEnvironment object.
def run(self):
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.
Returns
List[Node]Undocumented
domain =
names: List[str] =
objtype =