:py:mod:`myst_parser.warnings_`
===============================

.. py:module:: myst_parser.warnings_

.. autodoc2-docstring:: myst_parser.warnings_
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`MystWarnings <myst_parser.warnings_.MystWarnings>`
     - .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`create_warning <myst_parser.warnings_.create_warning>`
     - .. autodoc2-docstring:: myst_parser.warnings_.create_warning
          :summary:

API
~~~

.. py:class:: MystWarnings
   :canonical: myst_parser.warnings_.MystWarnings

   Bases: :py:obj:`enum.Enum`

   .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings

   .. py:attribute:: DEPRECATED
      :canonical: myst_parser.warnings_.MystWarnings.DEPRECATED
      :value: 'deprecated'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.DEPRECATED

   .. py:attribute:: NOT_SUPPORTED
      :canonical: myst_parser.warnings_.MystWarnings.NOT_SUPPORTED
      :value: 'not_supported'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.NOT_SUPPORTED

   .. py:attribute:: RENDER_METHOD
      :canonical: myst_parser.warnings_.MystWarnings.RENDER_METHOD
      :value: 'render'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.RENDER_METHOD

   .. py:attribute:: MD_TOPMATTER
      :canonical: myst_parser.warnings_.MystWarnings.MD_TOPMATTER
      :value: 'topmatter'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.MD_TOPMATTER

   .. py:attribute:: MD_DEF_DUPE
      :canonical: myst_parser.warnings_.MystWarnings.MD_DEF_DUPE
      :value: 'duplicate_def'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.MD_DEF_DUPE

   .. py:attribute:: MD_FOOTNOTE_DUPE
      :canonical: myst_parser.warnings_.MystWarnings.MD_FOOTNOTE_DUPE
      :value: 'footnote'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.MD_FOOTNOTE_DUPE

   .. py:attribute:: MD_FOOTNOTE_MISSING
      :canonical: myst_parser.warnings_.MystWarnings.MD_FOOTNOTE_MISSING
      :value: 'footnote'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.MD_FOOTNOTE_MISSING

   .. py:attribute:: MD_HEADING_NON_CONSECUTIVE
      :canonical: myst_parser.warnings_.MystWarnings.MD_HEADING_NON_CONSECUTIVE
      :value: 'header'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.MD_HEADING_NON_CONSECUTIVE

   .. py:attribute:: DIRECTIVE_PARSING
      :canonical: myst_parser.warnings_.MystWarnings.DIRECTIVE_PARSING
      :value: 'directive_parse'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.DIRECTIVE_PARSING

   .. py:attribute:: UNKNOWN_DIRECTIVE
      :canonical: myst_parser.warnings_.MystWarnings.UNKNOWN_DIRECTIVE
      :value: 'directive_unknown'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.UNKNOWN_DIRECTIVE

   .. py:attribute:: UNKNOWN_ROLE
      :canonical: myst_parser.warnings_.MystWarnings.UNKNOWN_ROLE
      :value: 'role_unknown'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.UNKNOWN_ROLE

   .. py:attribute:: XREF_AMBIGUOUS
      :canonical: myst_parser.warnings_.MystWarnings.XREF_AMBIGUOUS
      :value: 'xref_ambiguous'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.XREF_AMBIGUOUS

   .. py:attribute:: XREF_MISSING
      :canonical: myst_parser.warnings_.MystWarnings.XREF_MISSING
      :value: 'xref_missing'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.XREF_MISSING

   .. py:attribute:: INV_LOAD
      :canonical: myst_parser.warnings_.MystWarnings.INV_LOAD
      :value: 'inv_retrieval'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.INV_LOAD

   .. py:attribute:: IREF_MISSING
      :canonical: myst_parser.warnings_.MystWarnings.IREF_MISSING
      :value: 'iref_missing'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.IREF_MISSING

   .. py:attribute:: IREF_AMBIGUOUS
      :canonical: myst_parser.warnings_.MystWarnings.IREF_AMBIGUOUS
      :value: 'iref_ambiguous'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.IREF_AMBIGUOUS

   .. py:attribute:: LEGACY_DOMAIN
      :canonical: myst_parser.warnings_.MystWarnings.LEGACY_DOMAIN
      :value: 'domains'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.LEGACY_DOMAIN

   .. py:attribute:: HEADING_SLUG
      :canonical: myst_parser.warnings_.MystWarnings.HEADING_SLUG
      :value: 'heading_slug'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.HEADING_SLUG

   .. py:attribute:: STRIKETHROUGH
      :canonical: myst_parser.warnings_.MystWarnings.STRIKETHROUGH
      :value: 'strikethrough'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.STRIKETHROUGH

   .. py:attribute:: HTML_PARSE
      :canonical: myst_parser.warnings_.MystWarnings.HTML_PARSE
      :value: 'html'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.HTML_PARSE

   .. py:attribute:: INVALID_ATTRIBUTE
      :canonical: myst_parser.warnings_.MystWarnings.INVALID_ATTRIBUTE
      :value: 'attribute'

      .. autodoc2-docstring:: myst_parser.warnings_.MystWarnings.INVALID_ATTRIBUTE

.. py:function:: create_warning(document: docutils.nodes.document, message: str, subtype: myst_parser.warnings_.MystWarnings, *, line: int | None = None, append_to: docutils.nodes.Element | None = None) -> docutils.nodes.system_message | None
   :canonical: myst_parser.warnings_.create_warning

   .. autodoc2-docstring:: myst_parser.warnings_.create_warning