hoverxref.domains.HoverXRefStandardDomainMixin Class Reference

Inheritance diagram for hoverxref.domains.HoverXRefStandardDomainMixin:

Collaboration diagram for hoverxref.domains.HoverXRefStandardDomainMixin:

Public Member Functions
	resolve_xref (self, env, fromdocname, builder, typ, target, node, contnode)

Public Attributes
	hoverxref_types

Protected Member Functions
	_resolve_ref_xref (self, env, fromdocname, builder, typ, target, node, contnode)
	_resolve_obj_xref (self, env, fromdocname, builder, typ, target, node, contnode)
	_resolve_numref_xref (self, env, fromdocname, builder, typ, target, node, contnode)
Protected Member Functions inherited from hoverxref.domains.HoverXRefBaseDomain
	_inject_hoverxref_data (self, env, refnode, typ)
	_is_ignored_ref (self, env, target)

Additional Inherited Members
Static Public Attributes inherited from hoverxref.domains.HoverXRefBaseDomain
tuple	hoverxref_types

Detailed Description

Mixin for ``StandardDomain`` to save the values after the xref resolution.

``:ref:`` are treating as a different node in Sphinx
(``sphinx.addnodes.pending_xref``). These nodes are translated to regular
``docsutils.nodes.reference`` for this domain class.

This class add the required ``hoverxref`` and ``modal``/``tooltip`` to tell
the frontend to show a modal/tooltip on this element.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/hoverxref/domains.py