update sphinx

Aminsinichi · Mar 22, 2024 · 2362899 · 2362899
1 parent 8badf86
commit 2362899
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 12 deletions.
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -13,3 +13,6 @@ seaborn
 statsmodels
 scipy
 astropy<6.0
+sphinx_markdown_tables
+recommonmark
+sphinx_rtd_theme
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -5,28 +5,34 @@
 
 import os
 import sys
-sys.path.insert(0, os.path.abspath('../..'))
+
+sys.path.insert(0, os.path.abspath("../.."))
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'wearablehrv'
-copyright = '2024, Amin Sinichi'
-author = 'Amin Sinichi'
-release = '0.1.12'
+project = "wearablehrv"
+copyright = "2024, Amin Sinichi"
+author = "Amin Sinichi"
+release = "0.1.12"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ['sphinx.ext.autodoc']
+extensions = [
+    "sphinx.ext.autodoc",
+    "recommonmark",
+    "sphinx_markdown_tables",
+    "sphinx_rtd_theme",
+]
 
-templates_path = ['_templates']
-exclude_patterns = []
 
+templates_path = ["_templates"]
+exclude_patterns = []
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -3,8 +3,7 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to wearablehrv's documentation!
-=======================================
+.. mdinclude:: ../../README.md
 
 .. toctree::
    :maxdepth: 2