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

.. py:module:: myst_parser.sphinx_ext.directives

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

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

Classes
~~~~~~~

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

   * - :py:obj:`SubstitutionReferenceRole <myst_parser.sphinx_ext.directives.SubstitutionReferenceRole>`
     - .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.SubstitutionReferenceRole
          :summary:
   * - :py:obj:`FigureMarkdown <myst_parser.sphinx_ext.directives.FigureMarkdown>`
     - .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`align <myst_parser.sphinx_ext.directives.align>`
     - .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.align
          :summary:
   * - :py:obj:`figwidth_value <myst_parser.sphinx_ext.directives.figwidth_value>`
     - .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.figwidth_value
          :summary:

API
~~~

.. py:function:: align(argument)
   :canonical: myst_parser.sphinx_ext.directives.align

   .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.align

.. py:function:: figwidth_value(argument)
   :canonical: myst_parser.sphinx_ext.directives.figwidth_value

   .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.figwidth_value

.. py:class:: SubstitutionReferenceRole
   :canonical: myst_parser.sphinx_ext.directives.SubstitutionReferenceRole

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

   .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.SubstitutionReferenceRole

   .. py:method:: run() -> typing.Tuple[typing.List[docutils.nodes.Node], typing.List[docutils.nodes.system_message]]
      :canonical: myst_parser.sphinx_ext.directives.SubstitutionReferenceRole.run

      .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.SubstitutionReferenceRole.run

.. py:class:: FigureMarkdown(name, arguments, options, content, lineno, content_offset, block_text, state, state_machine)
   :canonical: myst_parser.sphinx_ext.directives.FigureMarkdown

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

   .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown.__init__

   .. py:attribute:: required_arguments
      :canonical: myst_parser.sphinx_ext.directives.FigureMarkdown.required_arguments
      :value: 0

      .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown.required_arguments

   .. py:attribute:: optional_arguments
      :canonical: myst_parser.sphinx_ext.directives.FigureMarkdown.optional_arguments
      :value: 1

      .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown.optional_arguments

   .. py:attribute:: final_argument_whitespace
      :canonical: myst_parser.sphinx_ext.directives.FigureMarkdown.final_argument_whitespace
      :value: True

      .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown.final_argument_whitespace

   .. py:attribute:: has_content
      :canonical: myst_parser.sphinx_ext.directives.FigureMarkdown.has_content
      :value: True

      .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown.has_content

   .. py:attribute:: option_spec
      :canonical: myst_parser.sphinx_ext.directives.FigureMarkdown.option_spec
      :value: None

      .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown.option_spec

   .. py:method:: run() -> typing.List[docutils.nodes.Node]
      :canonical: myst_parser.sphinx_ext.directives.FigureMarkdown.run

      .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown.run

   .. py:method:: figure_error(message)
      :canonical: myst_parser.sphinx_ext.directives.FigureMarkdown.figure_error

      .. autodoc2-docstring:: myst_parser.sphinx_ext.directives.FigureMarkdown.figure_error