myst works but not with mermaid

endolith · endolith · commit 45c05cf35df0 · 2024-11-18T10:50:56.000-05:00
probably related to executablebooks/MyST-Parser#742 and executablebooks/MyST-Parser#366 and needing ```{mermaid} instead of the usual ```mermaid that renders in GitHub, Typora, etc.
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,7 +33,7 @@
 extensions = [
     'sphinx.ext.autodoc',
     'numpydoc',
-    'm2r2',
+    'myst_parser',
     'sphinxcontrib.mermaid',
     ]
 
@@ -63,12 +63,6 @@
     '.md': 'markdown',
 }
 
-# Map the markdown files to the m2r2 parser
-source_parsers = {
-    '.md': 'm2r2.parser.M2RParser',
-}
-
-
 # Copy ./examples/results images into documentation so they show up when
 # markdown files with relative paths are transcluded (suggested by ChatGPT-4)
 import os
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,8 +10,8 @@ Welcome to elsim's documentation!
    :maxdepth: 2
    :caption: Contents:
 
-.. mdinclude:: ../README.md
-
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
 
 
 Indices and tables
