From 9c8facc9254d3ebd071b14f48a829b561f70902b Mon Sep 17 00:00:00 2001
From: utensil <utensilcandel@gmail.com>
Date: Sat, 30 Mar 2024 19:13:12 +0800
Subject: [PATCH] Switch to use sphinx_mdinclude

---
 doc/conf.py                          | 4 +---
 doc/getting-started.rst              | 2 --
 doc/index.rst                        | 1 -
 doc/readthedocs-pip-requirements.txt | 1 +
 4 files changed, 2 insertions(+), 6 deletions(-)

diff --git a/doc/conf.py b/doc/conf.py
index 9721de6c..8d2b8e78 100644
--- 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
index e2960dfb..97d49585 100644
--- 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
index 21fa0289..7b1043c6 100644
--- 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
index 6036a085..13e0824c 100644
--- 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