myst_parser.sphinx_ext.directives.SubstitutionReferenceRole Class Reference

Inheritance diagram for myst_parser.sphinx_ext.directives.SubstitutionReferenceRole:

Collaboration diagram for myst_parser.sphinx_ext.directives.SubstitutionReferenceRole:

Public Member Functions
tuple[list[nodes.Node], list[nodes.system_message]]	run (self)
Public Member Functions inherited from sphinx.util.docutils.SphinxRole
tuple[list[Node], list[system_message]]	__call__ (self, str name, str rawtext, str text, int lineno, Inliner inliner, dict[str, Any]|None options=None, Sequence[str] content=())
BuildEnvironment	env (self)
Config	config (self)
tuple[str, int]	get_source_info (self, int|None lineno=None)
None	set_source_info (self, Node node, int|None lineno=None)
str	get_location (self)

Public Attributes
	lineno
Public Attributes inherited from sphinx.util.docutils.SphinxRole
	rawtext
	text
	lineno
	inliner
	options
	content
	name

Additional Inherited Members
Static Public Attributes inherited from sphinx.util.docutils.SphinxRole
str	name
str	rawtext
str	text
int	lineno
Inliner	inliner
dict	options [str, Any]
Sequence	content [str]

Detailed Description

Implement substitution references as a role.

Note, in ``docutils/parsers/rst/roles.py`` this is left unimplemented.

Member Function Documentation

run()

tuple[list[nodes.Node], list[nodes.system_message]] myst_parser.sphinx_ext.directives.SubstitutionReferenceRole.run

(

self

)

Reimplemented from sphinx.util.docutils.SphinxRole.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/myst_parser/sphinx_ext/directives.py