class CAliasObject(ObjectDescription):
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. |
sphinx.directives.ObjectDescription.run
Returns | |
List[ | Undocumented |