sphinx.addnodes.desc_signature

class documentation

class desc_signature(_desc_classes_injector, nodes.Part, nodes.Inline, nodes.TextElement): (source)

View In Hierarchy

Node for a single object signature. As default the signature is a single-line signature. Set ``is_multiline = True`` to describe a multi-line signature. In that case all child nodes must be :py:class:`desc_signature_line` nodes. This node always has the classes ``sig``, ``sig-object``, and the domain it belongs to.

Class Variable classes Undocumented
Property child_text_separator Undocumented

Inherited from _desc_classes_injector:

Method __init__ Undocumented

Inherited from not_smartquotable (via _desc_classes_injector):

Class Variable support_smartquotes Undocumented
classes: list[str] = (source)
overrides sphinx.addnodes._desc_classes_injector.classes

Undocumented

@property
child_text_separator = (source)

Undocumented