Replace sphinx_mdinclude with MyST (#587)

zostera · Apr 18, 2024 · 5428269 · 5428269
1 parent dc2492f
commit 5428269
Show file tree

Hide file tree

Showing 6 changed files with 10 additions and 7 deletions.
diff --git a/.readthedocs.yml → .readthedocs.yaml b/.readthedocs.yml → .readthedocs.yaml
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1 +1,2 @@
-.. mdinclude:: ../CHANGELOG.md
+.. include:: ../CHANGELOG.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/conf.py b/docs/conf.py
@@ -15,7 +15,7 @@
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
-    "sphinx_mdinclude",
+    "myst_parser",
 ]
 
 htmlhelp_basename = f"{project}-doc"

diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -1 +1,2 @@
-.. mdinclude:: ../CONTRIBUTING.md
+.. include:: ../CONTRIBUTING.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/migrate.rst b/docs/migrate.rst
@@ -1 +1,2 @@
-.. mdinclude:: ../MIGRATE.md
+.. include:: ../MIGRATE.md
+   :parser: myst_parser.sphinx_
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,3 +1,3 @@
-sphinx>=7.2.6
-sphinx-mdinclude>=0.5.3
-furo>=2023.05.20
+sphinx==7.3.5
+furo==2024.1.29
+myst-parser==2.0.0