sphinx.domains.math.MathReferenceRole

class documentation

class MathReferenceRole(XRefRole): (source)

View In Hierarchy

Undocumented

Method result_nodes Called before returning the finished nodes. *node* is the reference node if one was created (*is_ref* is then true), else the content node. This method can add other nodes and must return a ``(nodes, messages)`` tuple (the usual return value of a role function).

Inherited from XRefRole:

Method __init__ Undocumented
Method create_non_xref_node Undocumented
Method create_xref_node Undocumented
Method process_link Called after parsing title and target text, and creating the reference node (given in *refnode*). This method can alter the reference node and must return a new (or the same) ``(title, target)`` tuple.
Method run Undocumented
Method update_title_and_target Undocumented
Instance Variable classes Undocumented
Instance Variable fix_parens Undocumented
Instance Variable has_explicit_title Undocumented
Instance Variable innernodeclass Undocumented
Instance Variable lowercase Undocumented
Instance Variable nodeclass Undocumented
Instance Variable refdomain Undocumented
Instance Variable reftype Undocumented
Instance Variable warn_dangling Undocumented

Inherited from ReferenceRole (via XRefRole):

Method __call__ Undocumented
Class Variable explicit_title_re Undocumented
Instance Variable disabled Undocumented
Instance Variable target Undocumented
Instance Variable title Undocumented

Inherited from SphinxRole (via XRefRole, ReferenceRole):

Method get_location Get current location info for logging.
Method get_source_info Undocumented
Method set_source_info Undocumented
Instance Variable content Undocumented
Instance Variable inliner Undocumented
Instance Variable lineno Undocumented
Instance Variable name Undocumented
Instance Variable options Undocumented
Instance Variable rawtext Undocumented
Instance Variable text Undocumented
Property config Reference to the :class:`.Config` object.
Property env Reference to the :class:`.BuildEnvironment` object.
def result_nodes(self, document, env, node, is_ref): (source)
overrides sphinx.roles.XRefRole.result_nodes

Called before returning the finished nodes. *node* is the reference node if one was created (*is_ref* is then true), else the content node. This method can add other nodes and must return a ``(nodes, messages)`` tuple (the usual return value of a role function).

Parameters
document:nodes.documentUndocumented
env:BuildEnvironmentUndocumented
node:ElementUndocumented
is_ref:boolUndocumented
Returns
tuple[list[Node], list[system_message]]Undocumented