:py:mod:`myst_parser.config.main`
=================================

.. py:module:: myst_parser.config.main

.. autodoc2-docstring:: myst_parser.config.main
   :allowtitles:

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

Classes
~~~~~~~

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

   * - :py:obj:`UrlSchemeType <myst_parser.config.main.UrlSchemeType>`
     - .. autodoc2-docstring:: myst_parser.config.main.UrlSchemeType
          :summary:
   * - :py:obj:`MdParserConfig <myst_parser.config.main.MdParserConfig>`
     - .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig
          :summary:

Functions
~~~~~~~~~

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

   * - :py:obj:`check_extensions <myst_parser.config.main.check_extensions>`
     - .. autodoc2-docstring:: myst_parser.config.main.check_extensions
          :summary:
   * - :py:obj:`check_url_schemes <myst_parser.config.main.check_url_schemes>`
     - .. autodoc2-docstring:: myst_parser.config.main.check_url_schemes
          :summary:
   * - :py:obj:`check_sub_delimiters <myst_parser.config.main.check_sub_delimiters>`
     - .. autodoc2-docstring:: myst_parser.config.main.check_sub_delimiters
          :summary:
   * - :py:obj:`check_inventories <myst_parser.config.main.check_inventories>`
     - .. autodoc2-docstring:: myst_parser.config.main.check_inventories
          :summary:
   * - :py:obj:`check_heading_slug_func <myst_parser.config.main.check_heading_slug_func>`
     - .. autodoc2-docstring:: myst_parser.config.main.check_heading_slug_func
          :summary:
   * - :py:obj:`check_fence_as_directive <myst_parser.config.main.check_fence_as_directive>`
     - .. autodoc2-docstring:: myst_parser.config.main.check_fence_as_directive
          :summary:
   * - :py:obj:`merge_file_level <myst_parser.config.main.merge_file_level>`
     - .. autodoc2-docstring:: myst_parser.config.main.merge_file_level
          :summary:
   * - :py:obj:`read_topmatter <myst_parser.config.main.read_topmatter>`
     - .. autodoc2-docstring:: myst_parser.config.main.read_topmatter
          :summary:

API
~~~

.. py:function:: check_extensions(inst: MdParserConfig, field: dataclasses.Field, value: typing.Any) -> None
   :canonical: myst_parser.config.main.check_extensions

   .. autodoc2-docstring:: myst_parser.config.main.check_extensions

.. py:class:: UrlSchemeType()
   :canonical: myst_parser.config.main.UrlSchemeType

   Bases: :py:obj:`typing.TypedDict`

   .. autodoc2-docstring:: myst_parser.config.main.UrlSchemeType

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.config.main.UrlSchemeType.__init__

   .. py:attribute:: url
      :canonical: myst_parser.config.main.UrlSchemeType.url
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.config.main.UrlSchemeType.url

   .. py:attribute:: title
      :canonical: myst_parser.config.main.UrlSchemeType.title
      :type: str
      :value: None

      .. autodoc2-docstring:: myst_parser.config.main.UrlSchemeType.title

   .. py:attribute:: classes
      :canonical: myst_parser.config.main.UrlSchemeType.classes
      :type: list[str]
      :value: None

      .. autodoc2-docstring:: myst_parser.config.main.UrlSchemeType.classes

.. py:function:: check_url_schemes(inst: MdParserConfig, field: dataclasses.Field, value: typing.Any) -> None
   :canonical: myst_parser.config.main.check_url_schemes

   .. autodoc2-docstring:: myst_parser.config.main.check_url_schemes

.. py:function:: check_sub_delimiters(_: MdParserConfig, field: dataclasses.Field, value: typing.Any) -> None
   :canonical: myst_parser.config.main.check_sub_delimiters

   .. autodoc2-docstring:: myst_parser.config.main.check_sub_delimiters

.. py:function:: check_inventories(_: MdParserConfig, field: dataclasses.Field, value: typing.Any) -> None
   :canonical: myst_parser.config.main.check_inventories

   .. autodoc2-docstring:: myst_parser.config.main.check_inventories

.. py:function:: check_heading_slug_func(inst: MdParserConfig, field: dataclasses.Field, value: typing.Any) -> None
   :canonical: myst_parser.config.main.check_heading_slug_func

   .. autodoc2-docstring:: myst_parser.config.main.check_heading_slug_func

.. py:function:: check_fence_as_directive(inst: MdParserConfig, field: dataclasses.Field, value: typing.Any) -> None
   :canonical: myst_parser.config.main.check_fence_as_directive

   .. autodoc2-docstring:: myst_parser.config.main.check_fence_as_directive

.. py:class:: MdParserConfig
   :canonical: myst_parser.config.main.MdParserConfig

   .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig

   .. py:attribute:: commonmark_only
      :canonical: myst_parser.config.main.MdParserConfig.commonmark_only
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.commonmark_only

   .. py:attribute:: gfm_only
      :canonical: myst_parser.config.main.MdParserConfig.gfm_only
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.gfm_only

   .. py:attribute:: enable_extensions
      :canonical: myst_parser.config.main.MdParserConfig.enable_extensions
      :type: set[str]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.enable_extensions

   .. py:attribute:: disable_syntax
      :canonical: myst_parser.config.main.MdParserConfig.disable_syntax
      :type: collections.abc.Iterable[str]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.disable_syntax

   .. py:attribute:: all_links_external
      :canonical: myst_parser.config.main.MdParserConfig.all_links_external
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.all_links_external

   .. py:attribute:: links_external_new_tab
      :canonical: myst_parser.config.main.MdParserConfig.links_external_new_tab
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.links_external_new_tab

   .. py:attribute:: url_schemes
      :canonical: myst_parser.config.main.MdParserConfig.url_schemes
      :type: dict[str, myst_parser.config.main.UrlSchemeType | None]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.url_schemes

   .. py:attribute:: ref_domains
      :canonical: myst_parser.config.main.MdParserConfig.ref_domains
      :type: collections.abc.Iterable[str] | None
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.ref_domains

   .. py:attribute:: fence_as_directive
      :canonical: myst_parser.config.main.MdParserConfig.fence_as_directive
      :type: set[str]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.fence_as_directive

   .. py:attribute:: number_code_blocks
      :canonical: myst_parser.config.main.MdParserConfig.number_code_blocks
      :type: collections.abc.Sequence[str]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.number_code_blocks

   .. py:attribute:: title_to_header
      :canonical: myst_parser.config.main.MdParserConfig.title_to_header
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.title_to_header

   .. py:attribute:: heading_anchors
      :canonical: myst_parser.config.main.MdParserConfig.heading_anchors
      :type: int
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.heading_anchors

   .. py:attribute:: heading_slug_func
      :canonical: myst_parser.config.main.MdParserConfig.heading_slug_func
      :type: collections.abc.Callable[[str], str] | None
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.heading_slug_func

   .. py:attribute:: html_meta
      :canonical: myst_parser.config.main.MdParserConfig.html_meta
      :type: dict[str, str]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.html_meta

   .. py:attribute:: footnote_sort
      :canonical: myst_parser.config.main.MdParserConfig.footnote_sort
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.footnote_sort

   .. py:attribute:: footnote_transition
      :canonical: myst_parser.config.main.MdParserConfig.footnote_transition
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.footnote_transition

   .. py:attribute:: words_per_minute
      :canonical: myst_parser.config.main.MdParserConfig.words_per_minute
      :type: int
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.words_per_minute

   .. py:attribute:: substitutions
      :canonical: myst_parser.config.main.MdParserConfig.substitutions
      :type: dict[str, typing.Any]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.substitutions

   .. py:attribute:: sub_delimiters
      :canonical: myst_parser.config.main.MdParserConfig.sub_delimiters
      :type: tuple[str, str]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.sub_delimiters

   .. py:attribute:: linkify_fuzzy_links
      :canonical: myst_parser.config.main.MdParserConfig.linkify_fuzzy_links
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.linkify_fuzzy_links

   .. py:attribute:: dmath_allow_labels
      :canonical: myst_parser.config.main.MdParserConfig.dmath_allow_labels
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.dmath_allow_labels

   .. py:attribute:: dmath_allow_space
      :canonical: myst_parser.config.main.MdParserConfig.dmath_allow_space
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.dmath_allow_space

   .. py:attribute:: dmath_allow_digits
      :canonical: myst_parser.config.main.MdParserConfig.dmath_allow_digits
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.dmath_allow_digits

   .. py:attribute:: dmath_double_inline
      :canonical: myst_parser.config.main.MdParserConfig.dmath_double_inline
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.dmath_double_inline

   .. py:attribute:: update_mathjax
      :canonical: myst_parser.config.main.MdParserConfig.update_mathjax
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.update_mathjax

   .. py:attribute:: mathjax_classes
      :canonical: myst_parser.config.main.MdParserConfig.mathjax_classes
      :type: str
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.mathjax_classes

   .. py:attribute:: enable_checkboxes
      :canonical: myst_parser.config.main.MdParserConfig.enable_checkboxes
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.enable_checkboxes

   .. py:attribute:: strikethrough_single_tilde
      :canonical: myst_parser.config.main.MdParserConfig.strikethrough_single_tilde
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.strikethrough_single_tilde

   .. py:attribute:: colon_fence_exact_match
      :canonical: myst_parser.config.main.MdParserConfig.colon_fence_exact_match
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.colon_fence_exact_match

   .. py:attribute:: suppress_warnings
      :canonical: myst_parser.config.main.MdParserConfig.suppress_warnings
      :type: collections.abc.Sequence[str]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.suppress_warnings

   .. py:attribute:: highlight_code_blocks
      :canonical: myst_parser.config.main.MdParserConfig.highlight_code_blocks
      :type: bool
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.highlight_code_blocks

   .. py:attribute:: inventories
      :canonical: myst_parser.config.main.MdParserConfig.inventories
      :type: dict[str, tuple[str, str | None]]
      :value: 'field(...)'

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.inventories

   .. py:method:: copy(**kwargs: typing.Any) -> myst_parser.config.main.MdParserConfig
      :canonical: myst_parser.config.main.MdParserConfig.copy

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.copy

   .. py:method:: get_fields() -> tuple[dataclasses.Field, ...]
      :canonical: myst_parser.config.main.MdParserConfig.get_fields
      :classmethod:

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.get_fields

   .. py:method:: as_dict(dict_factory=dict) -> dict
      :canonical: myst_parser.config.main.MdParserConfig.as_dict

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.as_dict

   .. py:method:: as_triple() -> collections.abc.Iterable[tuple[str, typing.Any, dataclasses.Field]]
      :canonical: myst_parser.config.main.MdParserConfig.as_triple

      .. autodoc2-docstring:: myst_parser.config.main.MdParserConfig.as_triple

.. py:function:: merge_file_level(config: myst_parser.config.main.MdParserConfig, topmatter: dict[str, typing.Any], warning: collections.abc.Callable[[myst_parser.warnings_.MystWarnings, str], None]) -> myst_parser.config.main.MdParserConfig
   :canonical: myst_parser.config.main.merge_file_level

   .. autodoc2-docstring:: myst_parser.config.main.merge_file_level

.. py:exception:: TopmatterReadError()
   :canonical: myst_parser.config.main.TopmatterReadError

   Bases: :py:obj:`Exception`

   .. autodoc2-docstring:: myst_parser.config.main.TopmatterReadError

   .. rubric:: Initialization

   .. autodoc2-docstring:: myst_parser.config.main.TopmatterReadError.__init__

.. py:function:: read_topmatter(text: str | collections.abc.Iterator[str]) -> dict[str, typing.Any] | None
   :canonical: myst_parser.config.main.read_topmatter

   .. autodoc2-docstring:: myst_parser.config.main.read_topmatter