Set sphinx-material theme for documentation

fabcor-maxiv · Mar 18, 2024 · 8ccc1d5 · 8ccc1d5
1 parent c316987
commit 8ccc1d5
Show file tree

Hide file tree

Showing 3 changed files with 92 additions and 2 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -42,7 +42,24 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "furo"
+html_theme = "sphinx_material"
+
+html_theme_options = {
+    "globaltoc_collapse": True,
+    "globaltoc_depth": -1,
+    "repo_name": "GitHub mxcube/mxcubecore",
+    "repo_type": "github",
+    "repo_url": "https://github.com/mxcube/mxcubecore",
+}
+
+html_sidebars = {
+    "**": [
+        "logo-text.html",
+        "globaltoc.html",
+        "localtoc.html",
+        "searchbox.html",
+    ],
+}
 
 
 # -- Extensions --------------------------------------------------------------

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -49,6 +49,7 @@ PyTango = { version = "^9.3.6", optional = true }
 python-ldap = "^3.4.0"
 requests = "^2.31.0"
 colorama = "^0.4.6"
+sphinx-material = "^0.0.36"
 
 [tool.poetry.dev-dependencies]
 pylint = "^2.15.6"