Skip to content

Commit 42db169

Browse files
committed
Render .md files with MyST-parser
1 parent 7ef35b9 commit 42db169

File tree

3 files changed

+4
-12
lines changed

3 files changed

+4
-12
lines changed

docs/environment.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ dependencies:
66
- python=3.7
77
- sphinx
88
- sphinx_rtd_theme
9-
- recommonmark
109
- pillow
1110
- pip
1211
- pip:
13-
- readthedocs-sphinx-ext
12+
- myst_parser
13+
- readthedocs-sphinx-ext

docs/source/conf.py

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,6 @@
1313
import os
1414
import shlex
1515

16-
# Needed for conversion from markdown to html
17-
import recommonmark.parser
18-
1916
# If extensions (or modules to document with autodoc) are in another directory,
2017
# add these directories to sys.path here. If the directory is relative to the
2118
# documentation root, use os.path.abspath to make it absolute, like shown here.
@@ -35,17 +32,12 @@
3532
'sphinx.ext.napoleon',
3633
"sphinx.ext.extlinks",
3734
"sphinx.ext.viewcode",
38-
"recommonmark"
35+
"myst_parser"
3936
]
4037

4138
# Add any paths that contain templates here, relative to this directory.
4239
templates_path = ['_templates']
4340

44-
# Jupyter uses recommonmark's parser to convert markdown
45-
source_parsers = {
46-
'.md': 'recommonmark.parser.CommonMarkParser',
47-
}
48-
4941
# The suffix(es) of source filenames.
5042
# You can specify multiple suffix as a list of string:
5143
# source_suffix = ['.rst', '.md']

requirements-doc.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
sphinx_rtd_theme
22
sphinx
3-
recommonmark
3+
myst-parser

0 commit comments

Comments
 (0)