Remove m2r dependency for documentation

M2R is not maintained anymore and myst-parser provides the same functionality.
sleweke-bayer · May 6, 2024 · beb3509 · beb3509
1 parent d2b4c27
commit beb3509
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 5 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -31,11 +31,17 @@
     'sphinx_sitemap',
     'sphinxcontrib.bibtex',
     'sphinx_multiversion',
-    'm2r',
+    "myst_parser",
 ]
 
 # Bibliography
 bibtex_bibfiles = ['literature.bib']
+# Myst
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".txt": "markdown",
+    ".md": "markdown",
+}
 
 # Multiversion
 smv_released_pattern = r'^refs/tags/.*$'    # Tags only

diff --git a/doc/getting_started/build_linux.rst b/doc/getting_started/build_linux.rst
@@ -3,4 +3,4 @@
 Build for Linux
 ===============
 
-.. mdinclude:: ../../BUILD-LINUX.md
+.. literalinclude:: ../../BUILD-LINUX.md
diff --git a/doc/getting_started/build_osx.rst b/doc/getting_started/build_osx.rst
@@ -3,4 +3,4 @@
 Build for OSX
 =============
 
-.. mdinclude:: ../../BUILD-OSX.md
+.. literalinclude:: ../../BUILD-OSX.md
diff --git a/doc/getting_started/build_windows.rst b/doc/getting_started/build_windows.rst
@@ -3,4 +3,4 @@
 Build for MS Windows
 ====================
 
-.. mdinclude:: ../../BUILD-WINDOWS.md
+.. literalinclude:: ../../BUILD-WINDOWS.md
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -2,4 +2,4 @@ sphinx
 sphinx-sitemap
 sphinxcontrib-bibtex
 sphinx_multiversion
-m2r
+myst-parser