hoverxref.domains

Module Contents

Classes

HoverXRefBaseDomain
HoverXRefPythonDomainMixin
HoverXRefStandardDomainMixin	Mixin for StandardDomain to save the values after the xref resolution.
HoverXRefBibtexDomainMixin	Mixin for BibtexDomain to save the values after the xref resolution.

Attributes

logger

hoverxref.domains.logger

class hoverxref.domains.HoverXRefBaseDomain

hoverxref_types = ['hoverxref', 'hoverxreftooltip', 'hoverxrefmodal']

_inject_hoverxref_data(env, refnode, typ)

_is_ignored_ref(env, target)

class hoverxref.domains.HoverXRefPythonDomainMixin

Bases: HoverXRefBaseDomain

resolve_xref(env, fromdocname, builder, typ, target, node, contnode)

class hoverxref.domains.HoverXRefStandardDomainMixin

Bases: HoverXRefBaseDomain

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.

resolve_xref(env, fromdocname, builder, typ, target, node, contnode)

_resolve_ref_xref(env, fromdocname, builder, typ, target, node, contnode)

_resolve_obj_xref(env, fromdocname, builder, typ, target, node, contnode)

_resolve_numref_xref(env, fromdocname, builder, typ, target, node, contnode)

class hoverxref.domains.HoverXRefBibtexDomainMixin

Bases: HoverXRefBaseDomain

Mixin for BibtexDomain to save the values after the xref resolution.

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

https://github.com/mcmtroffaes/sphinxcontrib-bibtex/blob/2.4.1/src/sphinxcontrib/bibtex/domain.py#L281

resolve_xref(env, fromdocname, builder, typ, target, node, contnode)