update sphinx

Aminsinichi · Mar 22, 2024 · 56e390e · 56e390e
1 parent 2362899
commit 56e390e
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 11 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -14,5 +14,5 @@ statsmodels
 scipy
 astropy<6.0
 sphinx_markdown_tables
-recommonmark
+m2r2
 sphinx_rtd_theme
diff --git a/docs/source/api_group_pipeline.rst b/docs/source/api_group_pipeline.rst
@@ -0,0 +1,7 @@
+API - Group Pipeline
+====================
+
+.. automodule:: wearablehrv.group
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/api_individual_pipeline.rst b/docs/source/api_individual_pipeline.rst
@@ -0,0 +1,7 @@
+API - Individual Pipeline
+=========================
+
+.. automodule:: wearablehrv.individual
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -21,7 +21,7 @@
 
 extensions = [
     "sphinx.ext.autodoc",
-    "recommonmark",
+    "m2r2",
     "sphinx_markdown_tables",
     "sphinx_rtd_theme",
 ]

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,25 +3,22 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+Welcome to the wearablehrv documentation!
+=========================================
+
 .. mdinclude:: ../../README.md
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
-.. automodule:: wearablehrv.individual
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-.. automodule:: wearablehrv.group
-   :members:
-   :undoc-members:
-   :show-inheritance:
+   api_individual_pipeline
+   api_group_pipeline
 
 Indices and tables
 ==================
 
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+