change myst_parser -> sphinx_mdinclude

umami-hep · Oct 9, 2022 · f90f8b1 · f90f8b1
1 parent 17a3978
commit f90f8b1
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 14 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,6 +1,6 @@
 librep
-myst-parser~=0.17.0
 pydata-sphinx-theme==0.11.0
 sphinx-autoapi
 sphinx-copybutton
-Sphinx~=4.2.0
+sphinx_mdinclude
+Sphinx~=5.2.3
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -37,7 +37,7 @@
 # ones.
 extensions = [
     "sphinx.ext.napoleon",  # add support for numpy-style docstrings
-    "myst_parser",  # to include markdown files in the documentation
+    "sphinx_mdinclude",  # to include markdown files in the documentation
     "autoapi.extension",  # generates the API section of our documentation
     "sphinx_copybutton",  # adds a copy-button to each code cell
 ]

diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst
@@ -7,14 +7,13 @@ can be used as a starting point for your plotting scripts.
 .. toctree::
    :maxdepth: 2
 
-   dummy_data.md
-   histograms.md
-   rocs.md
-   var_vs_eff.md
-   fraction_scan.md
-   pie_charts.md
-   line_plots.md
+   .. mdinclude:: dummy_data.md
+   .. mdinclude:: histograms.md
+   .. mdinclude:: rocs.md
+   .. mdinclude:: var_vs_eff.md
+   .. mdinclude:: fraction_scan.md
+   .. mdinclude:: pie_charts.md
+   .. mdinclude:: line_plots.md
 
 
-.. include:: index.md
-   :parser: myst_parser.sphinx_
+.. mdinclude:: index.md
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -1,6 +1,5 @@
 .. include README.md as the home site
-.. include:: ../../README.md
-   :parser: myst_parser.sphinx_
+.. mdinclude:: ../../README.md
 
 .. table of contents on the left side of the website
 .. toctree::