Skip to content

Commit 50f7438

Browse files
authored
Merge pull request #139 from bashtage/update-markdown
MAINT: Switch markdown from recommonmark to MySt-parser
2 parents ac74442 + f50d579 commit 50f7438

File tree

3 files changed

+5
-14
lines changed

3 files changed

+5
-14
lines changed

docs/conf.py

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,6 @@
1616
# sys.path.insert(0, os.path.abspath('.'))
1717
from distutils.version import LooseVersion
1818

19-
from recommonmark.transform import AutoStructify
20-
2119
import sphinx_material
2220

2321
FORCE_CLASSIC = os.environ.get("SPHINX_MATERIAL_FORCE_CLASSIC", False)
@@ -49,10 +47,10 @@
4947
"sphinx.ext.mathjax",
5048
"sphinx.ext.viewcode",
5149
"nbsphinx",
52-
"recommonmark",
5350
"sphinx_markdown_tables",
5451
"sphinx_copybutton",
5552
"sphinx_search.extension",
53+
"myst_parser",
5654
]
5755

5856
autosummary_generate = True
@@ -161,12 +159,6 @@
161159

162160
# Enable eval_rst in markdown
163161
def setup(app):
164-
app.add_config_value(
165-
"recommonmark_config",
166-
{"enable_math": True, "enable_inline_math": True, "enable_eval_rst": True},
167-
True,
168-
)
169-
app.add_transform(AutoStructify)
170162
app.add_object_type(
171163
"confval",
172164
"confval",

docs/markdown.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
# Markdown
22

3-
Sphinx can be configured to use markdown using the [recommonmark](https://github.com/readthedocs/recommonmark)
4-
extension. recommonmark is strict and does not natively support tables or common extensions
5-
to markdown.
3+
Sphinx can be configured to use markdown using the [MyST-parser](https://github.com/executablebooks/MyST-Parser)
4+
extension.
65

76
---
87

docs/requirements.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ jupyter_client
88
notebook
99
nbconvert
1010
ipykernel
11-
recommonmark
11+
myst-parser
1212
sphinx_markdown_tables
1313
sphinx-copybutton
14-
readthedocs-sphinx-search
14+
readthedocs-sphinx-search

0 commit comments

Comments
 (0)