sphinx.domains.std.Target

class documentation

class Target(SphinxDirective): (source)

View In Hierarchy

Generic target for user-defined cross-reference types.

Method make_old_id Generate old styled node_id for targets.
Method run Undocumented
Class Variable final_argument_whitespace Undocumented
Class Variable has_content Undocumented
Class Variable indextemplate Undocumented
Class Variable option_spec Undocumented
Class Variable optional_arguments Undocumented
Class Variable required_arguments Undocumented

Inherited from SphinxDirective:

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 :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def make_old_id(self, name): (source)

Generate old styled node_id for targets. .. note:: Old Styled node_id was used until Sphinx-3.0. This will be removed in Sphinx-5.0.

Parameters
name:strUndocumented
Returns
strUndocumented
def run(self): (source)

Undocumented

Returns
list[Node]Undocumented
final_argument_whitespace: bool = (source)

Undocumented

has_content: bool = (source)

Undocumented

indextemplate: str = (source)

Undocumented

option_spec: OptionSpec = (source)

Undocumented

optional_arguments: int = (source)

Undocumented

required_arguments: int = (source)

Undocumented