/
__init__.py
65 lines (44 loc) · 1.97 KB
/
__init__.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
from typing import TYPE_CHECKING
__version__ = "0.16.1"
if TYPE_CHECKING:
from sphinx.application import Sphinx
def setup(app):
"""Initialize Sphinx extension."""
from myst_parser.sphinx_parser import MystParser
app.add_source_suffix(".md", "markdown")
app.add_source_parser(MystParser)
setup_sphinx(app)
return {"version": __version__, "parallel_read_safe": True}
def setup_sphinx(app: "Sphinx"):
"""Initialize all settings and transforms in Sphinx."""
# we do this separately to setup,
# so that it can be called by external packages like myst_nb
from myst_parser.directives import FigureMarkdown, SubstitutionReferenceRole
from myst_parser.main import MdParserConfig
from myst_parser.mathjax import override_mathjax
from myst_parser.myst_refs import MystReferenceResolver
app.add_role("sub-ref", SubstitutionReferenceRole())
app.add_directive("figure-md", FigureMarkdown)
app.add_post_transform(MystReferenceResolver)
for name, default in MdParserConfig().as_dict().items():
# TODO add types?
app.add_config_value(f"myst_{name}", default, "env")
app.connect("builder-inited", create_myst_config)
app.connect("builder-inited", override_mathjax)
def create_myst_config(app):
from sphinx.util import logging
# Ignore type checkers because the attribute is dynamically assigned
from sphinx.util.console import bold # type: ignore[attr-defined]
from myst_parser.main import MdParserConfig
logger = logging.getLogger(__name__)
values = {
name: app.config[f"myst_{name}"]
for name in MdParserConfig().as_dict().keys()
if name != "renderer"
}
try:
app.env.myst_config = MdParserConfig(**values)
logger.info(bold("myst v%s:") + " %s", __version__, app.env.myst_config)
except (TypeError, ValueError) as error:
logger.error("myst configuration invalid: %s", error.args[0])
app.env.myst_config = MdParserConfig()