:py:mod:`myst_parser.mdit_to_docutils.sphinx_`
==============================================

.. py:module:: myst_parser.mdit_to_docutils.sphinx_

.. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`SphinxRenderer <myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer>`
     - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer
          :summary:

Data
~~~~

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

   * - :py:obj:`LOGGER <myst_parser.mdit_to_docutils.sphinx_.LOGGER>`
     - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.LOGGER
          :summary:

API
~~~

.. py:data:: LOGGER
   :canonical: myst_parser.mdit_to_docutils.sphinx_.LOGGER
   :value: 'getLogger(...)'

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.LOGGER

.. py:class:: SphinxRenderer(parser: markdown_it.main.MarkdownIt)
   :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer

   Bases: :py:obj:`myst_parser.mdit_to_docutils.base.DocutilsRenderer`

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.__init__

   .. py:property:: sphinx_env
      :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.sphinx_env
      :type: sphinx.environment.BuildEnvironment

   .. py:method:: render_link_project(token: markdown_it.tree.SyntaxTreeNode) -> None
      :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_link_project

   .. py:method:: render_link_path(token: markdown_it.tree.SyntaxTreeNode) -> None
      :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_link_path

   .. py:method:: render_link_unknown(token: markdown_it.tree.SyntaxTreeNode) -> None
      :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_link_unknown

      .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_link_unknown

   .. py:method:: get_inventory_matches(*, invs: str | None, domains: str | None, otypes: str | None, target: str | None) -> list[myst_parser.inventory.InvMatch]
      :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.get_inventory_matches

   .. py:method:: render_math_block_label(token: markdown_it.tree.SyntaxTreeNode) -> None
      :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_math_block_label

      .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_math_block_label

   .. py:method:: render_amsmath(token: markdown_it.tree.SyntaxTreeNode) -> None
      :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_amsmath

      .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.render_amsmath

   .. py:method:: add_math_target(node: docutils.nodes.math_block) -> docutils.nodes.target
      :canonical: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.add_math_target

      .. autodoc2-docstring:: myst_parser.mdit_to_docutils.sphinx_.SphinxRenderer.add_math_target
