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

.. py:module:: myst_parser.mdit_to_docutils.html_to_nodes

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`make_error <myst_parser.mdit_to_docutils.html_to_nodes.make_error>`
     - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.make_error
          :summary:
   * - :py:obj:`default_html <myst_parser.mdit_to_docutils.html_to_nodes.default_html>`
     - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.default_html
          :summary:
   * - :py:obj:`html_to_nodes <myst_parser.mdit_to_docutils.html_to_nodes.html_to_nodes>`
     - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.html_to_nodes
          :summary:

Data
~~~~

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

   * - :py:obj:`OPTION_KEYS_IMAGE <myst_parser.mdit_to_docutils.html_to_nodes.OPTION_KEYS_IMAGE>`
     - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.OPTION_KEYS_IMAGE
          :summary:
   * - :py:obj:`OPTION_KEYS_ADMONITION <myst_parser.mdit_to_docutils.html_to_nodes.OPTION_KEYS_ADMONITION>`
     - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.OPTION_KEYS_ADMONITION
          :summary:
   * - :py:obj:`RE_FLOW <myst_parser.mdit_to_docutils.html_to_nodes.RE_FLOW>`
     - .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.RE_FLOW
          :summary:

API
~~~

.. py:function:: make_error(document: docutils.nodes.document, error_msg: str, text: str, line_number: int) -> docutils.nodes.system_message
   :canonical: myst_parser.mdit_to_docutils.html_to_nodes.make_error

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.make_error

.. py:data:: OPTION_KEYS_IMAGE
   :canonical: myst_parser.mdit_to_docutils.html_to_nodes.OPTION_KEYS_IMAGE
   :value: None

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.OPTION_KEYS_IMAGE

.. py:data:: OPTION_KEYS_ADMONITION
   :canonical: myst_parser.mdit_to_docutils.html_to_nodes.OPTION_KEYS_ADMONITION
   :value: None

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.OPTION_KEYS_ADMONITION

.. py:data:: RE_FLOW
   :canonical: myst_parser.mdit_to_docutils.html_to_nodes.RE_FLOW
   :value: 'compile(...)'

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.RE_FLOW

.. py:function:: default_html(text: str, source: str, line_number: int) -> list[docutils.nodes.Element]
   :canonical: myst_parser.mdit_to_docutils.html_to_nodes.default_html

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.default_html

.. py:function:: html_to_nodes(text: str, line_number: int, renderer: myst_parser.mdit_to_docutils.base.DocutilsRenderer) -> list[docutils.nodes.Element]
   :canonical: myst_parser.mdit_to_docutils.html_to_nodes.html_to_nodes

   .. autodoc2-docstring:: myst_parser.mdit_to_docutils.html_to_nodes.html_to_nodes
