Switch to use sphinx_mdinclude

pygae · Mar 30, 2024 · 9c8facc · 9c8facc
1 parent f34412e
commit 9c8facc
Show file tree

Hide file tree

Showing 4 changed files with 2 additions and 6 deletions.
diff --git a/doc/conf.py b/doc/conf.py
@@ -54,9 +54,7 @@
     'releases',
     'sphinxcontrib.bibtex',
     'sphinx_rtd_theme',
-
-    # local extensions
-    'md_include',
+    'sphinx_mdinclude'
 ]
 
 # This is not actually used as we have a template overload to render this with

diff --git a/doc/getting-started.rst b/doc/getting-started.rst
@@ -1,3 +1 @@
 .. mdinclude:: ../README.md
-    :start-after: <!-- begin: getting-started -->
-    :end-before: <!-- end: getting-started -->
diff --git a/doc/index.rst b/doc/index.rst
@@ -1,5 +1,4 @@
 .. mdinclude:: ../README.md
-    :end-before: <!-- begin:
 
 .. these are all hidden, because they render more clearly in the sidebar.
 

diff --git a/doc/readthedocs-pip-requirements.txt b/doc/readthedocs-pip-requirements.txt
@@ -11,6 +11,7 @@ ipykernel
 nbsphinx
 numba
 sphinx-rtd-theme
+sphinx_mdinclude
 
 sphinx-markdown-tables
 notedown