Use MyST for parsing Markdown files in documentation

north-numerical-computing · Jan 11, 2025 · 0fdd461 · 0fdd461
1 parent 90e4955
commit 0fdd461
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 4 deletions.
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
@@ -10,8 +10,7 @@ jobs:
 
       - name: Install and Build
         run: |
-          sudo apt install -y doxygen graphviz
-          pip install sphinx sphinx_rtd_theme breathe exhale m2r2
+          sudo apt install -y doxygen graphviz python3-sphinx python3-breathe python3-sphinx-rtd-theme python3-breathe python3-exhale python3-myst-parser
           make docs
 
       - name: Deploy

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -34,7 +34,7 @@
     'sphinx.ext.githubpages',
     'breathe',
     'exhale',
-    'm2r2',
+    'myst_parser',
 ]
 
 # Setup the breathe extension

diff --git a/docs/source/readme.rst b/docs/source/readme.rst
@@ -1 +1,2 @@
-.. mdinclude:: ../../README.md
+.. include:: ../../README.md
+   :parser: myst_parser.docutils_