:orphan:

:py:mod:`myst_parser._docs`
===========================

.. py:module:: myst_parser._docs

.. autodoc2-docstring:: myst_parser._docs
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`StripUnsupportedLatex <myst_parser._docs.StripUnsupportedLatex>`
     - .. autodoc2-docstring:: myst_parser._docs.StripUnsupportedLatex
          :summary:
   * - :py:obj:`NumberSections <myst_parser._docs.NumberSections>`
     - .. autodoc2-docstring:: myst_parser._docs.NumberSections
          :summary:
   * - :py:obj:`MystConfigDirective <myst_parser._docs.MystConfigDirective>`
     -
   * - :py:obj:`DocutilsCliHelpDirective <myst_parser._docs.DocutilsCliHelpDirective>`
     - .. autodoc2-docstring:: myst_parser._docs.DocutilsCliHelpDirective
          :summary:
   * - :py:obj:`DirectiveDoc <myst_parser._docs.DirectiveDoc>`
     - .. autodoc2-docstring:: myst_parser._docs.DirectiveDoc
          :summary:
   * - :py:obj:`MystWarningsDirective <myst_parser._docs.MystWarningsDirective>`
     - .. autodoc2-docstring:: myst_parser._docs.MystWarningsDirective
          :summary:
   * - :py:obj:`MystExampleDirective <myst_parser._docs.MystExampleDirective>`
     - .. autodoc2-docstring:: myst_parser._docs.MystExampleDirective
          :summary:
   * - :py:obj:`MystAdmonitionDirective <myst_parser._docs.MystAdmonitionDirective>`
     - .. autodoc2-docstring:: myst_parser._docs.MystAdmonitionDirective
          :summary:
   * - :py:obj:`MystToHTMLDirective <myst_parser._docs.MystToHTMLDirective>`
     - .. autodoc2-docstring:: myst_parser._docs.MystToHTMLDirective
          :summary:
   * - :py:obj:`MystLexer <myst_parser._docs.MystLexer>`
     - .. autodoc2-docstring:: myst_parser._docs.MystLexer
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`convert_opt <myst_parser._docs.convert_opt>`
     - .. autodoc2-docstring:: myst_parser._docs.convert_opt
          :summary:

Data
~~~~

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

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

API
~~~

.. py:data:: LOGGER
   :canonical: myst_parser._docs.LOGGER
   :value: None

   .. autodoc2-docstring:: myst_parser._docs.LOGGER

.. py:class:: StripUnsupportedLatex(document, startnode=None)
   :canonical: myst_parser._docs.StripUnsupportedLatex

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

   .. autodoc2-docstring:: myst_parser._docs.StripUnsupportedLatex

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.StripUnsupportedLatex.__init__

   .. py:attribute:: default_priority
      :canonical: myst_parser._docs.StripUnsupportedLatex.default_priority
      :value: 900

      .. autodoc2-docstring:: myst_parser._docs.StripUnsupportedLatex.default_priority

   .. py:method:: run()
      :canonical: myst_parser._docs.StripUnsupportedLatex.run

.. py:class:: NumberSections(document, startnode=None)
   :canonical: myst_parser._docs.NumberSections

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

   .. autodoc2-docstring:: myst_parser._docs.NumberSections

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.NumberSections.__init__

   .. py:attribute:: default_priority
      :canonical: myst_parser._docs.NumberSections.default_priority
      :value: 710

      .. autodoc2-docstring:: myst_parser._docs.NumberSections.default_priority

   .. py:attribute:: formats
      :canonical: myst_parser._docs.NumberSections.formats
      :value: ('html',)

      .. autodoc2-docstring:: myst_parser._docs.NumberSections.formats

   .. py:method:: run()
      :canonical: myst_parser._docs.NumberSections.run

.. py:class:: MystConfigDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
   :canonical: myst_parser._docs.MystConfigDirective

   Bases: :py:obj:`myst_parser._docs._ConfigBase`

   .. py:attribute:: option_spec
      :canonical: myst_parser._docs.MystConfigDirective.option_spec
      :value: None

      .. autodoc2-docstring:: myst_parser._docs.MystConfigDirective.option_spec

   .. py:method:: run()
      :canonical: myst_parser._docs.MystConfigDirective.run

      .. autodoc2-docstring:: myst_parser._docs.MystConfigDirective.run

.. py:class:: DocutilsCliHelpDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
   :canonical: myst_parser._docs.DocutilsCliHelpDirective

   Bases: :py:obj:`sphinx.util.docutils.SphinxDirective`

   .. autodoc2-docstring:: myst_parser._docs.DocutilsCliHelpDirective

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.DocutilsCliHelpDirective.__init__

   .. py:attribute:: has_content
      :canonical: myst_parser._docs.DocutilsCliHelpDirective.has_content
      :value: False

      .. autodoc2-docstring:: myst_parser._docs.DocutilsCliHelpDirective.has_content

   .. py:attribute:: required_arguments
      :canonical: myst_parser._docs.DocutilsCliHelpDirective.required_arguments
      :value: 0

      .. autodoc2-docstring:: myst_parser._docs.DocutilsCliHelpDirective.required_arguments

   .. py:attribute:: optional_arguments
      :canonical: myst_parser._docs.DocutilsCliHelpDirective.optional_arguments
      :value: 0

      .. autodoc2-docstring:: myst_parser._docs.DocutilsCliHelpDirective.optional_arguments

   .. py:attribute:: final_argument_whitespace
      :canonical: myst_parser._docs.DocutilsCliHelpDirective.final_argument_whitespace
      :value: False

      .. autodoc2-docstring:: myst_parser._docs.DocutilsCliHelpDirective.final_argument_whitespace

   .. py:method:: run()
      :canonical: myst_parser._docs.DocutilsCliHelpDirective.run

      .. autodoc2-docstring:: myst_parser._docs.DocutilsCliHelpDirective.run

.. py:class:: DirectiveDoc(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
   :canonical: myst_parser._docs.DirectiveDoc

   Bases: :py:obj:`sphinx.util.docutils.SphinxDirective`

   .. autodoc2-docstring:: myst_parser._docs.DirectiveDoc

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.DirectiveDoc.__init__

   .. py:attribute:: required_arguments
      :canonical: myst_parser._docs.DirectiveDoc.required_arguments
      :value: 1

      .. autodoc2-docstring:: myst_parser._docs.DirectiveDoc.required_arguments

   .. py:attribute:: has_content
      :canonical: myst_parser._docs.DirectiveDoc.has_content
      :value: True

      .. autodoc2-docstring:: myst_parser._docs.DirectiveDoc.has_content

   .. py:method:: run()
      :canonical: myst_parser._docs.DirectiveDoc.run

      .. autodoc2-docstring:: myst_parser._docs.DirectiveDoc.run

.. py:function:: convert_opt(name, func)
   :canonical: myst_parser._docs.convert_opt

   .. autodoc2-docstring:: myst_parser._docs.convert_opt

.. py:class:: MystWarningsDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
   :canonical: myst_parser._docs.MystWarningsDirective

   Bases: :py:obj:`sphinx.util.docutils.SphinxDirective`

   .. autodoc2-docstring:: myst_parser._docs.MystWarningsDirective

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.MystWarningsDirective.__init__

   .. py:attribute:: has_content
      :canonical: myst_parser._docs.MystWarningsDirective.has_content
      :value: False

      .. autodoc2-docstring:: myst_parser._docs.MystWarningsDirective.has_content

   .. py:attribute:: required_arguments
      :canonical: myst_parser._docs.MystWarningsDirective.required_arguments
      :value: 0

      .. autodoc2-docstring:: myst_parser._docs.MystWarningsDirective.required_arguments

   .. py:attribute:: optional_arguments
      :canonical: myst_parser._docs.MystWarningsDirective.optional_arguments
      :value: 0

      .. autodoc2-docstring:: myst_parser._docs.MystWarningsDirective.optional_arguments

   .. py:attribute:: final_argument_whitespace
      :canonical: myst_parser._docs.MystWarningsDirective.final_argument_whitespace
      :value: False

      .. autodoc2-docstring:: myst_parser._docs.MystWarningsDirective.final_argument_whitespace

   .. py:method:: run()
      :canonical: myst_parser._docs.MystWarningsDirective.run

      .. autodoc2-docstring:: myst_parser._docs.MystWarningsDirective.run

.. py:class:: MystExampleDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
   :canonical: myst_parser._docs.MystExampleDirective

   Bases: :py:obj:`sphinx.util.docutils.SphinxDirective`

   .. autodoc2-docstring:: myst_parser._docs.MystExampleDirective

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.MystExampleDirective.__init__

   .. py:attribute:: has_content
      :canonical: myst_parser._docs.MystExampleDirective.has_content
      :value: True

      .. autodoc2-docstring:: myst_parser._docs.MystExampleDirective.has_content

   .. py:attribute:: option_spec
      :canonical: myst_parser._docs.MystExampleDirective.option_spec
      :value: None

      .. autodoc2-docstring:: myst_parser._docs.MystExampleDirective.option_spec

   .. py:method:: run()
      :canonical: myst_parser._docs.MystExampleDirective.run

      .. autodoc2-docstring:: myst_parser._docs.MystExampleDirective.run

.. py:class:: MystAdmonitionDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
   :canonical: myst_parser._docs.MystAdmonitionDirective

   Bases: :py:obj:`sphinx.util.docutils.SphinxDirective`

   .. autodoc2-docstring:: myst_parser._docs.MystAdmonitionDirective

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.MystAdmonitionDirective.__init__

   .. py:attribute:: required_arguments
      :canonical: myst_parser._docs.MystAdmonitionDirective.required_arguments
      :value: 1

      .. autodoc2-docstring:: myst_parser._docs.MystAdmonitionDirective.required_arguments

   .. py:attribute:: final_argument_whitespace
      :canonical: myst_parser._docs.MystAdmonitionDirective.final_argument_whitespace
      :value: True

      .. autodoc2-docstring:: myst_parser._docs.MystAdmonitionDirective.final_argument_whitespace

   .. py:method:: run()
      :canonical: myst_parser._docs.MystAdmonitionDirective.run

      .. autodoc2-docstring:: myst_parser._docs.MystAdmonitionDirective.run

.. py:class:: MystToHTMLDirective(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
   :canonical: myst_parser._docs.MystToHTMLDirective

   Bases: :py:obj:`sphinx.util.docutils.SphinxDirective`

   .. autodoc2-docstring:: myst_parser._docs.MystToHTMLDirective

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.MystToHTMLDirective.__init__

   .. py:attribute:: has_content
      :canonical: myst_parser._docs.MystToHTMLDirective.has_content
      :value: True

      .. autodoc2-docstring:: myst_parser._docs.MystToHTMLDirective.has_content

   .. py:attribute:: optional_arguments
      :canonical: myst_parser._docs.MystToHTMLDirective.optional_arguments
      :value: 1

      .. autodoc2-docstring:: myst_parser._docs.MystToHTMLDirective.optional_arguments

   .. py:attribute:: final_argument_whitespace
      :canonical: myst_parser._docs.MystToHTMLDirective.final_argument_whitespace
      :value: True

      .. autodoc2-docstring:: myst_parser._docs.MystToHTMLDirective.final_argument_whitespace

   .. py:attribute:: option_spec
      :canonical: myst_parser._docs.MystToHTMLDirective.option_spec
      :value: None

      .. autodoc2-docstring:: myst_parser._docs.MystToHTMLDirective.option_spec

   .. py:method:: run()
      :canonical: myst_parser._docs.MystToHTMLDirective.run

      .. autodoc2-docstring:: myst_parser._docs.MystToHTMLDirective.run

.. py:class:: MystLexer(**options)
   :canonical: myst_parser._docs.MystLexer

   Bases: :py:obj:`pygments.lexers.markup.MarkdownLexer`

   .. autodoc2-docstring:: myst_parser._docs.MystLexer

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser._docs.MystLexer.__init__

   .. py:attribute:: name
      :canonical: myst_parser._docs.MystLexer.name
      :value: 'MyST'

      .. autodoc2-docstring:: myst_parser._docs.MystLexer.name

   .. py:attribute:: aliases
      :canonical: myst_parser._docs.MystLexer.aliases
      :value: ['myst']

      .. autodoc2-docstring:: myst_parser._docs.MystLexer.aliases

   .. py:attribute:: filenames
      :canonical: myst_parser._docs.MystLexer.filenames
      :value: ['*.myst']

      .. autodoc2-docstring:: myst_parser._docs.MystLexer.filenames

   .. py:attribute:: mimetypes
      :canonical: myst_parser._docs.MystLexer.mimetypes
      :value: ['text/x-myst']

      .. autodoc2-docstring:: myst_parser._docs.MystLexer.mimetypes

   .. py:attribute:: tokens
      :canonical: myst_parser._docs.MystLexer.tokens
      :value: None

      .. autodoc2-docstring:: myst_parser._docs.MystLexer.tokens