myst_parser.config.main.MdParserConfig Class Reference

Collaboration diagram for myst_parser.config.main.MdParserConfig:

Public Member Functions
str	__repr__ (self)
	__post_init__ (self)
"MdParserConfig"	copy (self, **Any kwargs)
tuple[dc.Field,...]	get_fields (cls)
dict	as_dict (self, dict_factory=dict)
Iterable[tuple[str, Any, dc.Field]]	as_triple (self)

Static Public Attributes
bool	commonmark_only
bool	gfm_only
set	enable_extensions
Iterable	disable_syntax
bool	all_links_external
bool	links_external_new_tab
dict	url_schemes
Iterable	ref_domains
set	fence_as_directive
Sequence	number_code_blocks
bool	title_to_header
int	heading_anchors
Callable	heading_slug_func
dict	html_meta
bool	footnote_sort
bool	footnote_transition
int	words_per_minute
dict	substitutions
tuple	sub_delimiters
bool	linkify_fuzzy_links
bool	dmath_allow_labels
bool	dmath_allow_space
bool	dmath_allow_digits
bool	dmath_double_inline
bool	update_mathjax
str	mathjax_classes
bool	enable_checkboxes
Sequence	suppress_warnings
bool	highlight_code_blocks
dict	inventories

Detailed Description

Configuration options for the Markdown Parser.

Note in the sphinx configuration these option names are prepended with ``myst_``

Member Function Documentation

__repr__()

str myst_parser.config.main.MdParserConfig.__repr__

(

self

)

Return a string representation of the config.

as_dict()

dict myst_parser.config.main.MdParserConfig.as_dict	(		self,
			dict_factory = dict
	)

Return a dictionary of field name -> value.

as_triple()

Iterable[tuple[str, Any, dc.Field]] myst_parser.config.main.MdParserConfig.as_triple

(

self

)

Yield triples of (name, value, field).

copy()

"MdParserConfig" myst_parser.config.main.MdParserConfig.copy	(		self,
		**Any	kwargs
	)

Return a new object replacing specified fields with new values.

Note: initiating the copy will also validate the new fields.

get_fields()

tuple[dc.Field, ...] myst_parser.config.main.MdParserConfig.get_fields

(

cls

)

Return all attribute fields in this class.

Member Data Documentation

all_links_external

bool myst_parser.config.main.MdParserConfig.all_links_external

static

Initial value:

=  dc.field(
        default=False,
        metadata={
            "validator": instance_of(bool),
            "help": "Parse all links as simple hyperlinks",
        },
    )

commonmark_only

bool myst_parser.config.main.MdParserConfig.commonmark_only

static

Initial value:

=  dc.field(
        default=False,
        metadata={
            "validator": instance_of(bool),
            "help": "Use strict CommonMark parser",
        },
    )

disable_syntax

Iterable myst_parser.config.main.MdParserConfig.disable_syntax

static

Initial value:

=  dc.field(
        default_factory=list,
        metadata={
            "validator": deep_iterable(instance_of(str), instance_of((list, tuple))),
            "help": "Disable Commonmark syntax elements",
        },
    )

dmath_allow_digits

bool myst_parser.config.main.MdParserConfig.dmath_allow_digits

static

Initial value:

=  dc.field(
        default=True,
        metadata={
            "validator": instance_of(bool),
            "help": "Allow initial/final digits `1$ ...$2`",
            "extension": "dollarmath",
        },
    )

dmath_allow_labels

bool myst_parser.config.main.MdParserConfig.dmath_allow_labels

static

Initial value:

=  dc.field(
        default=True,
        metadata={
            "validator": instance_of(bool),
            "help": "Parse `$$...$$ (label)`",
            "extension": "dollarmath",
        },
    )

dmath_allow_space

bool myst_parser.config.main.MdParserConfig.dmath_allow_space

static

Initial value:

=  dc.field(
        default=True,
        metadata={
            "validator": instance_of(bool),
            "help": "Allow initial/final spaces in `$ ... $`",
            "extension": "dollarmath",
        },
    )

dmath_double_inline

bool myst_parser.config.main.MdParserConfig.dmath_double_inline

static

Initial value:

=  dc.field(
        default=False,
        metadata={
            "validator": instance_of(bool),
            "help": "Parse inline `$$ ... $$`",
            "extension": "dollarmath",
        },
    )

enable_checkboxes

bool myst_parser.config.main.MdParserConfig.enable_checkboxes

static

Initial value:

=  dc.field(
        default=False,
        metadata={
            "validator": instance_of(bool),
            "help": "Enable checkboxes",
            "extension": "tasklist",
        },
    )

enable_extensions

set myst_parser.config.main.MdParserConfig.enable_extensions

static

Initial value:

=  dc.field(
        default_factory=set,
        metadata={"validator": check_extensions, "help": "Enable syntax extensions"},
    )

fence_as_directive

set myst_parser.config.main.MdParserConfig.fence_as_directive

static

Initial value:

=  dc.field(
        default_factory=set,
        metadata={
            "validator": check_fence_as_directive,
            "help": "Interpret a code fence as a directive, for certain language names. "
            "This can be useful for fences like dot and mermaid, "
            "and interoperability with other Markdown renderers.",
        },
    )

footnote_sort

bool myst_parser.config.main.MdParserConfig.footnote_sort

static

Initial value:

=  dc.field(
        default=True,
        metadata={
            "validator": instance_of(bool),
            "help": "Move all footnotes to the end of the document, and sort by reference order",
        },
    )

footnote_transition

bool myst_parser.config.main.MdParserConfig.footnote_transition

static

Initial value:

=  dc.field(
        default=True,
        metadata={
            "validator": instance_of(bool),
            "help": "Place a transition before sorted footnotes",
        },
    )

gfm_only

bool myst_parser.config.main.MdParserConfig.gfm_only

static

Initial value:

=  dc.field(
        default=False,
        metadata={
            "validator": instance_of(bool),
            "help": "Use strict Github Flavoured Markdown parser",
        },
    )

heading_anchors

int myst_parser.config.main.MdParserConfig.heading_anchors

static

Initial value:

=  dc.field(
        default=0,
        metadata={
            "validator": optional(in_([0, 1, 2, 3, 4, 5, 6, 7])),
            "help": "Heading level depth to assign HTML anchors",
        },
    )

heading_slug_func

Callable myst_parser.config.main.MdParserConfig.heading_slug_func

static

Initial value:

=  dc.field(
        default=None,
        metadata={
            "validator": check_heading_slug_func,
            "help": (
                "Function for creating heading anchors, "
                "or a python import path e.g. `my_package.my_module.my_function`"
            ),
            "global_only": True,
            "doc_type": "None | Callable[[str], str] | str",
        },
    )

highlight_code_blocks

bool myst_parser.config.main.MdParserConfig.highlight_code_blocks

static

Initial value:

=  dc.field(
        default=True,
        metadata={
            "validator": instance_of(bool),
            "help": "Syntax highlight code blocks with pygments",
            "omit": ["sphinx"],
        },
    )

html_meta

dict myst_parser.config.main.MdParserConfig.html_meta

static

Initial value:

=  dc.field(
        default_factory=dict,
        metadata={
            "validator": deep_mapping(
                instance_of(str), instance_of(str), instance_of(dict)
            ),
            "merge_topmatter": True,
            "help": "HTML meta tags",
            "repr_func": lambda v: f"{{{', '.join(f'{k}: ...' for k in v)}}}",
        },
    )

inventories

dict myst_parser.config.main.MdParserConfig.inventories

static

Initial value:

=  dc.field(
        default_factory=dict,
        repr=False,
        metadata={
            "validator": check_inventories,
            "help": "Mapping of key to (url, inv file), for intra-project referencing",
            "omit": ["sphinx"],
            "global_only": True,
        },
    )

linkify_fuzzy_links

bool myst_parser.config.main.MdParserConfig.linkify_fuzzy_links

static

Initial value:

=  dc.field(
        default=True,
        metadata={
            "validator": instance_of(bool),
            "help": "Recognise URLs without schema prefixes",
            "extension": "linkify",
        },
    )

links_external_new_tab

bool myst_parser.config.main.MdParserConfig.links_external_new_tab

static

Initial value:

=  dc.field(
        default=False,
        metadata={
            "validator": instance_of(bool),
            "help": "Open all external links in a new tab",
        },
    )

mathjax_classes

str myst_parser.config.main.MdParserConfig.mathjax_classes

static

Initial value:

=  dc.field(
        default="tex2jax_process|mathjax_process|math|output_area",
        metadata={
            "validator": instance_of(str),
            "help": "MathJax classes to add to math HTML",
            "extension": "dollarmath",
            "global_only": True,
            "omit": ["docutils"],
        },
    )

number_code_blocks

Sequence myst_parser.config.main.MdParserConfig.number_code_blocks

static

Initial value:

=  dc.field(
        default_factory=list,
        metadata={
            "validator": deep_iterable(instance_of(str), instance_of((list, tuple))),
            "help": "Add line numbers to code blocks with these languages",
        },
    )

ref_domains

Iterable myst_parser.config.main.MdParserConfig.ref_domains

static

Initial value:

=  dc.field(
        default=None,
        metadata={
            "validator": optional(
                deep_iterable(instance_of(str), instance_of((list, tuple)))
            ),
            "help": "Sphinx domain names to search in for link references",
            "omit": ["docutils"],
        },
    )

sub_delimiters

tuple myst_parser.config.main.MdParserConfig.sub_delimiters

static

Initial value:

=  dc.field(
        default=("{", "}"),
        repr=False,
        metadata={
            "validator": check_sub_delimiters,
            "help": "Substitution delimiters",
            "extension": "substitutions",
            "omit": ["docutils"],
        },
    )

substitutions

dict myst_parser.config.main.MdParserConfig.substitutions

static

Initial value:

=  dc.field(
        default_factory=dict,
        metadata={
            "validator": deep_mapping(instance_of(str), any_, instance_of(dict)),
            "merge_topmatter": True,
            "help": "Substitutions mapping",
            "extension": "substitutions",
            "repr_func": lambda v: f"{{{', '.join(f'{k}: ...' for k in v)}}}",
        },
    )

suppress_warnings

Sequence myst_parser.config.main.MdParserConfig.suppress_warnings

static

Initial value:

=  dc.field(
        default_factory=list,
        metadata={
            "validator": deep_iterable(instance_of(str), instance_of((list, tuple))),
            "help": "A list of warning types to suppress warning messages",
            "omit": ["sphinx"],
            "global_only": True,
        },
    )

title_to_header

bool myst_parser.config.main.MdParserConfig.title_to_header

static

Initial value:

=  dc.field(
        default=False,
        metadata={
            "validator": instance_of(bool),
            "help": "Convert a `title` field in the front-matter to a H1 header",
        },
    )

update_mathjax

bool myst_parser.config.main.MdParserConfig.update_mathjax

static

Initial value:

=  dc.field(
        default=True,
        metadata={
            "validator": instance_of(bool),
            "help": "Update sphinx.ext.mathjax configuration to ignore `$` delimiters",
            "extension": "dollarmath",
            "global_only": True,
            "omit": ["docutils"],
        },
    )

url_schemes

dict myst_parser.config.main.MdParserConfig.url_schemes

static

Initial value:

=  dc.field(
        default_factory=lambda: {
            "http": None,
            "https": None,
            "mailto": None,
            "ftp": None,
        },
        metadata={
            "validator": check_url_schemes,
            "help": "URI schemes that are converted to external links",
            "repr_func": lambda v: repr(tuple(v)),
            # Note, lists of strings will be coerced to dicts in the validator
            "doc_type": "list[str] | dict[str, None | str | dict]",
        },
    )

words_per_minute

int myst_parser.config.main.MdParserConfig.words_per_minute

static

Initial value:

=  dc.field(
        default=200,
        metadata={
            "validator": instance_of(int),
            "help": "For reading speed calculations",
        },
    )

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/myst_parser/config/main.py