:py:mod:`myst_parser.mocking`
=============================

.. py:module:: myst_parser.mocking

.. autodoc2-docstring:: myst_parser.mocking
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`MockInliner <myst_parser.mocking.MockInliner>`
     - .. autodoc2-docstring:: myst_parser.mocking.MockInliner
          :summary:
   * - :py:obj:`MockState <myst_parser.mocking.MockState>`
     - .. autodoc2-docstring:: myst_parser.mocking.MockState
          :summary:
   * - :py:obj:`MockStateMachine <myst_parser.mocking.MockStateMachine>`
     - .. autodoc2-docstring:: myst_parser.mocking.MockStateMachine
          :summary:
   * - :py:obj:`MockIncludeDirective <myst_parser.mocking.MockIncludeDirective>`
     - .. autodoc2-docstring:: myst_parser.mocking.MockIncludeDirective
          :summary:
   * - :py:obj:`MockRSTParser <myst_parser.mocking.MockRSTParser>`
     - .. autodoc2-docstring:: myst_parser.mocking.MockRSTParser
          :summary:

API
~~~

.. py:exception:: MockingError()
   :canonical: myst_parser.mocking.MockingError

   Bases: :py:obj:`Exception`

   .. autodoc2-docstring:: myst_parser.mocking.MockingError

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.mocking.MockingError.__init__

.. py:class:: MockInliner(renderer: myst_parser.mdit_to_docutils.base.DocutilsRenderer)
   :canonical: myst_parser.mocking.MockInliner

   .. autodoc2-docstring:: myst_parser.mocking.MockInliner

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.mocking.MockInliner.__init__

   .. py:method:: problematic(text: str, rawsource: str, message: docutils.nodes.system_message) -> docutils.nodes.problematic
      :canonical: myst_parser.mocking.MockInliner.problematic

      .. autodoc2-docstring:: myst_parser.mocking.MockInliner.problematic

   .. py:method:: parse(text: str, lineno: int, memo: typing.Any, parent: docutils.nodes.Node) -> tuple[list[docutils.nodes.Node], list[docutils.nodes.system_message]]
      :canonical: myst_parser.mocking.MockInliner.parse

      .. autodoc2-docstring:: myst_parser.mocking.MockInliner.parse

.. py:class:: MockState(renderer: myst_parser.mdit_to_docutils.base.DocutilsRenderer, state_machine: myst_parser.mocking.MockStateMachine, lineno: int)
   :canonical: myst_parser.mocking.MockState

   .. autodoc2-docstring:: myst_parser.mocking.MockState

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.mocking.MockState.__init__

   .. py:method:: parse_directive_block(content: docutils.statemachine.StringList, line_offset: int, directive: type[docutils.parsers.rst.Directive], option_presets: dict[str, typing.Any]) -> tuple[list[str], dict[str, typing.Any], docutils.statemachine.StringList, int]
      :canonical: myst_parser.mocking.MockState.parse_directive_block

      .. autodoc2-docstring:: myst_parser.mocking.MockState.parse_directive_block

   .. py:method:: nested_parse(block: docutils.statemachine.StringList, input_offset: int, node: docutils.nodes.Element, match_titles: bool = False, state_machine_class=None, state_machine_kwargs=None) -> None
      :canonical: myst_parser.mocking.MockState.nested_parse

      .. autodoc2-docstring:: myst_parser.mocking.MockState.nested_parse

   .. py:method:: parse_target(block, block_text, lineno: int)
      :canonical: myst_parser.mocking.MockState.parse_target

      .. autodoc2-docstring:: myst_parser.mocking.MockState.parse_target

   .. py:method:: inline_text(text: str, lineno: int) -> tuple[list[docutils.nodes.Element], list[docutils.nodes.Element]]
      :canonical: myst_parser.mocking.MockState.inline_text

      .. autodoc2-docstring:: myst_parser.mocking.MockState.inline_text

   .. py:attribute:: attribution_pattern
      :canonical: myst_parser.mocking.MockState.attribution_pattern
      :value: 'compile(...)'

      .. autodoc2-docstring:: myst_parser.mocking.MockState.attribution_pattern

   .. py:method:: block_quote(lines: list[str], line_offset: int) -> list[docutils.nodes.Element]
      :canonical: myst_parser.mocking.MockState.block_quote

      .. autodoc2-docstring:: myst_parser.mocking.MockState.block_quote

   .. py:method:: build_table(tabledata, tableline, stub_columns: int = 0, widths=None)
      :canonical: myst_parser.mocking.MockState.build_table

      .. autodoc2-docstring:: myst_parser.mocking.MockState.build_table

   .. py:method:: build_table_row(rowdata, tableline)
      :canonical: myst_parser.mocking.MockState.build_table_row

      .. autodoc2-docstring:: myst_parser.mocking.MockState.build_table_row

   .. py:method:: nest_line_block_lines(block: docutils.nodes.line_block)
      :canonical: myst_parser.mocking.MockState.nest_line_block_lines

      .. autodoc2-docstring:: myst_parser.mocking.MockState.nest_line_block_lines

.. py:class:: MockStateMachine(renderer: myst_parser.mdit_to_docutils.base.DocutilsRenderer, lineno: int)
   :canonical: myst_parser.mocking.MockStateMachine

   .. autodoc2-docstring:: myst_parser.mocking.MockStateMachine

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.mocking.MockStateMachine.__init__

   .. py:method:: get_source(lineno: int | None = None)
      :canonical: myst_parser.mocking.MockStateMachine.get_source

      .. autodoc2-docstring:: myst_parser.mocking.MockStateMachine.get_source

   .. py:method:: get_source_and_line(lineno: int | None = None)
      :canonical: myst_parser.mocking.MockStateMachine.get_source_and_line

      .. autodoc2-docstring:: myst_parser.mocking.MockStateMachine.get_source_and_line

.. py:class:: MockIncludeDirective(renderer: myst_parser.mdit_to_docutils.base.DocutilsRenderer, name: str, klass: type[docutils.parsers.rst.directives.misc.Include], arguments: list[str], options: dict[str, typing.Any], body: list[str], lineno: int)
   :canonical: myst_parser.mocking.MockIncludeDirective

   .. autodoc2-docstring:: myst_parser.mocking.MockIncludeDirective

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.mocking.MockIncludeDirective.__init__

   .. py:method:: run() -> list[docutils.nodes.Element]
      :canonical: myst_parser.mocking.MockIncludeDirective.run

      .. autodoc2-docstring:: myst_parser.mocking.MockIncludeDirective.run

   .. py:method:: add_name(node: docutils.nodes.Element)
      :canonical: myst_parser.mocking.MockIncludeDirective.add_name

      .. autodoc2-docstring:: myst_parser.mocking.MockIncludeDirective.add_name

.. py:class:: MockRSTParser(rfc2822=False, inliner=None)
   :canonical: myst_parser.mocking.MockRSTParser

   Bases: :py:obj:`docutils.parsers.rst.Parser`

   .. autodoc2-docstring:: myst_parser.mocking.MockRSTParser

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.mocking.MockRSTParser.__init__

   .. py:method:: parse(inputstring: str, document: docutils.nodes.document)
      :canonical: myst_parser.mocking.MockRSTParser.parse

      .. autodoc2-docstring:: myst_parser.mocking.MockRSTParser.parse