Merge pull request #139 from bashtage/update-markdown

MAINT: Switch markdown from recommonmark to MySt-parser
bashtage · Aug 18, 2023 · 50f7438 · 50f7438
2 parents ac74442 + f50d579
commit 50f7438
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 14 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -16,8 +16,6 @@
 # sys.path.insert(0, os.path.abspath('.'))
 from distutils.version import LooseVersion
 
-from recommonmark.transform import AutoStructify
-
 import sphinx_material
 
 FORCE_CLASSIC = os.environ.get("SPHINX_MATERIAL_FORCE_CLASSIC", False)
@@ -49,10 +47,10 @@
     "sphinx.ext.mathjax",
     "sphinx.ext.viewcode",
     "nbsphinx",
-    "recommonmark",
     "sphinx_markdown_tables",
     "sphinx_copybutton",
     "sphinx_search.extension",
+    "myst_parser",
 ]
 
 autosummary_generate = True
@@ -161,12 +159,6 @@
 
 # Enable eval_rst in markdown
 def setup(app):
-    app.add_config_value(
-        "recommonmark_config",
-        {"enable_math": True, "enable_inline_math": True, "enable_eval_rst": True},
-        True,
-    )
-    app.add_transform(AutoStructify)
     app.add_object_type(
         "confval",
         "confval",

diff --git a/docs/markdown.md b/docs/markdown.md
@@ -1,8 +1,7 @@
 # Markdown
 
-Sphinx can be configured to use markdown using the [recommonmark](https://github.com/readthedocs/recommonmark)
-extension. recommonmark is strict and does not natively support tables or common extensions
-to markdown.
+Sphinx can be configured to use markdown using the [MyST-parser](https://github.com/executablebooks/MyST-Parser)
+extension. 
 
 ---
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -8,7 +8,7 @@ jupyter_client
 notebook
 nbconvert
 ipykernel
-recommonmark
+myst-parser
 sphinx_markdown_tables
 sphinx-copybutton
-readthedocs-sphinx-search
+readthedocs-sphinx-search