Skip to content

Commit 61b9e80

Browse files
committed
fix markdown parse issue
1 parent 7f7699c commit 61b9e80

File tree

2 files changed

+8
-3
lines changed

2 files changed

+8
-3
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Remix libraries work as a core of native plugins of Remix IDE. Read more about l
2626
Steps to build this project as as:
2727
```
2828
pip3 install sphinx sphinx_rtd_theme
29-
pip3 install recommonmark
29+
pip3 install myst-parser
3030
git clone https://github.com/ethereum/remix-ide.git
3131
cd docs/
3232
make html

docs/conf.py

+7-2
Original file line numberDiff line numberDiff line change
@@ -30,14 +30,19 @@
3030
# Add any Sphinx extension module names here, as strings. They can be
3131
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
3232
# ones.
33-
extensions = ['recommonmark'] # required for sphinx v3.0.0
33+
extensions = ['myst_parser'] # required for sphinx v3.0.0
34+
suppress_warnings = ['myst.header']
35+
myst_disable_syntax = ['image']
3436

3537
# Add any paths that contain templates here, relative to this directory.
3638
templates_path = ['_templates']
3739

3840
# The suffix(es) of source filenames.
3941
# You can specify multiple suffix as a list of string:
40-
source_suffix = ['.rst', '.md']
42+
source_suffix = {
43+
'.rst': 'restructuredtext',
44+
'.md': 'markdown',
45+
}
4146

4247

4348
# The encoding of source files.

0 commit comments

Comments
 (0)