myst_parser.sphinx_ext.myst_refs.MystReferenceResolver Class Reference

Inheritance diagram for myst_parser.sphinx_ext.myst_refs.MystReferenceResolver:

Collaboration diagram for myst_parser.sphinx_ext.myst_refs.MystReferenceResolver:

Public Member Functions
	log_warning (self, None|str target, str msg, MystWarnings subtype, **Any kwargs)
None	run (self, **Any kwargs)
	resolve_myst_ref_doc (self, pending_xref node)
Element|None	resolve_myst_ref_any (self, str refdoc, pending_xref node, Element contnode, None|list[str] only_domains)
Public Member Functions inherited from sphinx.transforms.post_transforms.ReferencesResolver
None	warn_missing_reference (self, str refdoc, str typ, str target, pending_xref node, Domain|None domain)
list[Node]|None	find_pending_xref_condition (self, pending_xref node, Sequence[str] conditions)
Public Member Functions inherited from sphinx.transforms.post_transforms.SphinxPostTransform
None	apply (self, **Any kwargs)
bool	is_supported (self)
Public Member Functions inherited from sphinx.transforms.SphinxTransform
Sphinx	app (self)
BuildEnvironment	env (self)
Config	config (self)
Public Member Functions inherited from docutils.transforms.Transform
	__init__ (self, document, startnode=None)

Public Attributes
	document
	env
Public Attributes inherited from sphinx.transforms.post_transforms.ReferencesResolver
	env
Public Attributes inherited from docutils.transforms.Transform
	document
	startnode
	language

Static Public Attributes
int	default_priority = 9
Static Public Attributes inherited from sphinx.transforms.post_transforms.ReferencesResolver
int	default_priority = 10
Static Public Attributes inherited from sphinx.transforms.post_transforms.SphinxPostTransform
tuple	builders = ()
tuple	formats = ()
Static Public Attributes inherited from docutils.transforms.Transform
	default_priority = None

Protected Member Functions
Element|None	_resolve_ref_nested (self, pending_xref node, str fromdocname, target=None)
Element|None	_resolve_doc_nested (self, pending_xref node, str fromdocname)
None|nodes.reference	_resolve_myst_ref_intersphinx (self, nodes.Element node, nodes.Element contnode, str target, list[str]|None only_domains)
Protected Member Functions inherited from sphinx.transforms.post_transforms.ReferencesResolver
nodes.reference|None	_resolve_pending_xref (self, addnodes.pending_xref node, Element contnode)
nodes.reference|None	_resolve_pending_xref_in_domain (self, *Domain|None domain, addnodes.pending_xref node, Element contnode, str ref_doc, str typ, str target)
nodes.reference|None	_resolve_pending_any_xref (self, *addnodes.pending_xref node, Element contnode, str ref_doc, str target)

Detailed Description

Resolves cross-references on doctrees.

Overrides default sphinx implementation, to allow for nested syntax

Member Function Documentation

_resolve_doc_nested()

Element | None myst_parser.sphinx_ext.myst_refs.MystReferenceResolver._resolve_doc_nested (   self, pending_xref  node, str   fromdocname  )

protected

This is the same as ``sphinx.domains.std._resolve_doc_xref``,
but allows for nested syntax, rather than converting the inner node to raw text.

It also allows for extensions on document names.

_resolve_myst_ref_intersphinx()

None | nodes.reference myst_parser.sphinx_ext.myst_refs.MystReferenceResolver._resolve_myst_ref_intersphinx (   self, nodes.Element  node, nodes.Element  contnode, str  target, list[str] | None  only_domains  )

protected

Resolve a myst reference to an intersphinx inventory.

_resolve_ref_nested()

Element | None myst_parser.sphinx_ext.myst_refs.MystReferenceResolver._resolve_ref_nested (   self, pending_xref  node, str  fromdocname,   target = None  )

protected

This is the same as ``sphinx.domains.std._resolve_ref_xref``,
but allows for nested syntax, rather than converting the inner node to raw text.

log_warning()

myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.log_warning	(		self,
		None | str	target,
		str	msg,
		MystWarnings	subtype,
		**Any	kwargs
	)

Log a warning, with a myst type and specific subtype.

resolve_myst_ref_any()

Element | None myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.resolve_myst_ref_any	(		self,
		str	refdoc,
		pending_xref	node,
		Element	contnode,
		None | list[str]	only_domains
	)

Resolve reference generated by the "myst" role; ``[text](#reference)``.

This builds on the sphinx ``any`` role to also resolve:

- Document references with extensions; ``[text](./doc.md)``
- Document references with anchors with anchors; ``[text](./doc.md#target)``
- Nested syntax for explicit text with std:doc and std:ref;
  ``[**nested**](reference)``

resolve_myst_ref_doc()

myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.resolve_myst_ref_doc	(		self,
		pending_xref	node
	)

Resolve a reference, from a markdown link, to another document,
optionally with a target id within that document.

run()

None myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.run	(		self,
		**Any	kwargs
	)

Main method of post transforms.

Subclasses should override this method instead of ``apply()``.

Reimplemented from sphinx.transforms.post_transforms.ReferencesResolver.

---

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

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