sphinx.domains.std.GenericObject

class documentation

class GenericObject(ObjectDescription[str]):

Known subclasses: sphinx.domains.std.EnvVar

View In Hierarchy

A generic x-ref directive registered with Sphinx.add_object_type().
Method add​_target​_and​_index Undocumented
Method handle​_signature Undocumented
Method make​_old​_id Generate old styled node_id for generic objects.
Class Variable indextemplate Undocumented
Class Variable parse​_node Undocumented
def add_target_and_index(self, name, sig, signode):

Undocumented

Parameters
name:strUndocumented
sig:strUndocumented
signode:desc_signatureUndocumented
def handle_signature(self, sig, signode):

Undocumented

Parameters
sig:strUndocumented
signode:desc_signatureUndocumented
Returns
strUndocumented
def make_old_id(self, name):

Generate old styled node_id for generic objects.

Note

Old Styled node_id was used until Sphinx-3.0. This will be removed in Sphinx-5.0.

Parameters
name:strUndocumented
Returns
strUndocumented
indextemplate: str =
overridden in sphinx.domains.std.EnvVar

Undocumented

parse_node: Callable[[GenericObject, BuildEnvironment, str, desc_signature], str] =

Undocumented