New documentation style & formatting

athob · Aug 28, 2024 · 8c02714 · 8c02714
1 parent 3a340cb
commit 8c02714
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 7 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -8,7 +8,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.9"
     # You can also specify other tool versions:
     # nodejs: "20"
     # rust: "1.70"

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -64,7 +64,22 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'sphinx_rtd_theme' # 'furo'
+html_theme = 'pydata_sphinx_theme'
+
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": md.__url__,
+            "icon": "fab fa-github-square",
+            "type": "fontawesome",
+        },
+    ],
+}
+
+html_sidebars = {
+    "**": [],
+}
 
 # -- Options for automatic API doc
 

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -1,8 +1,8 @@
 sphinx-math-dollar
 sphinx-copybutton
-myst-nb
+myst-parser>=3
+myst-nb>=1
 linkify-it-py
-furo
-sphinx_rtd_theme
+pydata-sphinx-theme
 markdown
 lxml
diff --git a/py-EnBiD-ananke b/py-EnBiD-ananke
diff --git a/py-Galaxia-ananke b/py-Galaxia-ananke
+1 −1		.readthedocs.yaml
+35 −1		docs/source/conf.py
+4 −2		docs/source/requirements.txt