hoverxref.domains
=================

.. py:module:: hoverxref.domains


Attributes
----------

.. autoapisummary::

   hoverxref.domains.logger


Classes
-------

.. autoapisummary::

   hoverxref.domains.HoverXRefBaseDomain
   hoverxref.domains.HoverXRefPythonDomainMixin
   hoverxref.domains.HoverXRefStandardDomainMixin
   hoverxref.domains.HoverXRefBibtexDomainMixin


Module Contents
---------------

.. py:data:: logger

.. py:class:: HoverXRefBaseDomain

   .. py:attribute:: hoverxref_types
      :value: ('hoverxref', 'hoverxreftooltip', 'hoverxrefmodal')



   .. py:method:: _inject_hoverxref_data(env, refnode, typ)


   .. py:method:: _is_ignored_ref(env, target)


.. py:class:: HoverXRefPythonDomainMixin

   Bases: :py:obj:`HoverXRefBaseDomain`


   .. py:method:: resolve_xref(env, fromdocname, builder, typ, target, node, contnode)


.. py:class:: HoverXRefStandardDomainMixin

   Bases: :py:obj:`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.


   .. py:method:: resolve_xref(env, fromdocname, builder, typ, target, node, contnode)


   .. py:method:: _resolve_ref_xref(env, fromdocname, builder, typ, target, node, contnode)


   .. py:method:: _resolve_obj_xref(env, fromdocname, builder, typ, target, node, contnode)


   .. py:method:: _resolve_numref_xref(env, fromdocname, builder, typ, target, node, contnode)


.. py:class:: HoverXRefBibtexDomainMixin

   Bases: :py:obj:`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


   .. py:method:: resolve_xref(env, fromdocname, builder, typ, target, node, contnode)