(sphinx/config-options)=
MyST parsing can be configured at both the global and individual document level, with the most specific configuration taking precedence.
Overriding the default configuration at the global level is achieved by specifying variables in the Sphinx conf.py file.
All myst_parser global configuration variables are prefixed with myst_, e.g.
myst_enable_extensions = ["deflist"]:::{seealso} Configuration in Docutils, in the section. :::
:sphinx:
:scope: global
Configuration specific to syntax extensions:
:sphinx:
:extensions:
:scope: global
The following configuration variables are available at the document level.
These can be set in the document front matter, under the myst key, e.g.
---
myst:
enable_extensions: ["deflist"]
---:sphinx:
:scope: local
Configuration specific to syntax extensions:
:sphinx:
:extensions:
:scope: local
amsmath : enable direct parsing of amsmath LaTeX equations
attrs_inline : Enable inline attribute parsing, see here for details
colon_fence
: Enable code fences using ::: delimiters, see here for details
deflist : Enable definition lists, see here for details
dollarmath
: Enable parsing of dollar $ and $$ encapsulated math
fieldlist : Enable field lists, see here for details
html_admonition
: Convert <div class="admonition"> elements to sphinx admonition nodes, see the HTML admonition syntax for details
html_image
: Convert HTML <img> elements to sphinx image nodes, see here for details
inv_link
: Enable the inv: schema for Markdown link destinations, see here for details
linkify : Automatically identify "bare" web URLs and add hyperlinks
replacements : Automatically convert some common typographic texts
smartquotes : Automatically convert standard quotations to their opening/closing variants
strikethrough : Enable strikethrough syntax, see here for details
substitution : Substitute keys, see here for details
tasklist : Add check-boxes to the start of list items, see here for details
(howto/warnings)= (myst-warnings)=
Below lists the MyST specific warnings that may be emitted during the build process. These will be prepended to the end of the warning message, e.g.
WARNING: Non-consecutive header level increase; H1 to H3 [myst.header]
In general, if your build logs any warnings, you should either fix them or raise an Issue if you think the warning is erroneous.
However, in some circumstances if you wish to suppress the warning you can use the inv:sphinx#suppress_warnings configuration option, e.g.
suppress_warnings = ["myst.header"]Or use --myst-suppress-warnings="myst.header" for the docutils CLI.