:py:mod:`myst_parser.sphinx_ext.myst_refs`
==========================================

.. py:module:: myst_parser.sphinx_ext.myst_refs

.. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs
   :allowtitles:

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

Classes
~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`MystReferenceResolver <myst_parser.sphinx_ext.myst_refs.MystReferenceResolver>`
     - .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`LOGGER <myst_parser.sphinx_ext.myst_refs.LOGGER>`
     - .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.LOGGER
          :summary:

API
~~~

.. py:data:: LOGGER
   :canonical: myst_parser.sphinx_ext.myst_refs.LOGGER
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.LOGGER

.. py:class:: MystReferenceResolver(document, startnode=None)
   :canonical: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver

   Bases: :py:obj:`sphinx.transforms.post_transforms.ReferencesResolver`

   .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.__init__

   .. py:attribute:: default_priority
      :canonical: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.default_priority
      :value: 9

      .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.default_priority

   .. py:method:: log_warning(target: None | str, msg: str, subtype: myst_parser.warnings_.MystWarnings, **kwargs: typing.Any)
      :canonical: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.log_warning

      .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.log_warning

   .. py:method:: run(**kwargs: typing.Any) -> None
      :canonical: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.run

   .. py:method:: resolve_myst_ref_doc(node: sphinx.addnodes.pending_xref)
      :canonical: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.resolve_myst_ref_doc

      .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.resolve_myst_ref_doc

   .. py:method:: resolve_myst_ref_any(refdoc: str, node: sphinx.addnodes.pending_xref, contnode: docutils.nodes.Element, only_domains: None | list[str]) -> docutils.nodes.Element | None
      :canonical: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.resolve_myst_ref_any

      .. autodoc2-docstring:: myst_parser.sphinx_ext.myst_refs.MystReferenceResolver.resolve_myst_ref_any