minor changes

JessicaJohnBritto · Sep 19, 2024 · b97b192 · b97b192
1 parent 6cfbb58
commit b97b192
Show file tree

Hide file tree

Showing 8 changed files with 18 additions and 4 deletions.
diff --git a/docs/.ipynb_checkpoints/requirements-checkpoint.txt b/docs/.ipynb_checkpoints/requirements-checkpoint.txt
@@ -4,3 +4,4 @@ numpy
 scipy
 matplotlib
 myst_parser
+m2r2
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,3 +4,4 @@ numpy
 scipy
 matplotlib
 myst_parser
+m2r2
diff --git a/docs/source/.ipynb_checkpoints/conf-checkpoint.py b/docs/source/.ipynb_checkpoints/conf-checkpoint.py
@@ -50,7 +50,8 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'myst_parser',
+    # 'myst_parser',
+    'm2r2',
     'sphinx.ext.todo',            # Support for TODO notes
     # 'sphinx.ext.napoleon',        # Supports Google and NumPy style docstrings
     'sphinx.ext.viewcode',        # Add links to highlighted source code

diff --git a/docs/source/.ipynb_checkpoints/index-checkpoint.rst b/docs/source/.ipynb_checkpoints/index-checkpoint.rst
@@ -6,7 +6,11 @@
 Welcome to WalshPulSeqProtocol's documentation!
 ===============================================
 
-.. include:: ../README.md
+.. toctree::
+    :maxdepth: 2
+    :caption: Homepage:
+
+    readme
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/.ipynb_checkpoints/readme-checkpoint.rst b/docs/source/.ipynb_checkpoints/readme-checkpoint.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../../README.md
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -50,7 +50,8 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'myst_parser',
+    # 'myst_parser',
+    'm2r2',
     'sphinx.ext.todo',            # Support for TODO notes
     # 'sphinx.ext.napoleon',        # Supports Google and NumPy style docstrings
     'sphinx.ext.viewcode',        # Add links to highlighted source code

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,7 +6,11 @@
 Welcome to WalshPulSeqProtocol's documentation!
 ===============================================
 
-.. include:: ../README.md
+.. toctree::
+    :maxdepth: 2
+    :caption: Homepage:
+
+    readme
 
 .. toctree::
    :maxdepth: 2

diff --git a/docs/source/readme.rst b/docs/source/readme.rst
@@ -0,0 +1 @@
+.. mdinclude:: ../../README.md
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,3 +4,4 @@ numpy @@
     scipy
     matplotlib
     myst_parser
+    m2r2