Documentation theming + scrolling

lagadic · Dec 1, 2023 · bec1db7 · bec1db7
1 parent 56e2f2c
commit bec1db7
Showing 1 changed file with 28 additions and 1 deletion.
diff --git a/modules/python/doc/conf.py.in b/modules/python/doc/conf.py.in
@@ -157,8 +157,30 @@ html_theme_options = {
     "repo_name": "visp",
     "features": [
       "toc.follow",
-      "toc.integrate",
+      "toc.sticky",
       "navigation.instant"
+    ],
+    "palette": [
+        {
+            "media": "(prefers-color-scheme: light)",
+            "scheme": "default",
+            "toggle": {
+                "icon": "material/toggle-switch-off-outline",
+                "name": "Switch to dark mode",
+            },
+            "primary": "red",
+            "accent": "indigo"
+        },
+        {
+            "media": "(prefers-color-scheme: dark)",
+            "scheme": "slate",
+            "toggle": {
+                "icon": "material/toggle-switch",
+                "name": "Switch to light mode",
+            },
+            "primary": "red",
+            "accent": "indigo"
+        },
     ]
 }
 
@@ -358,6 +380,11 @@ class FilterNoIndexWarnings(WarningLogRecordTranslator):
     return super(FilterNoIndexWarnings, self).filter(record)
 
 
+object_description_options = [
+  ("py:.*", dict(include_fields_in_toc=False)),
+]
+
+
 def setup(app):
   import logging
   from sphinx.util.logging import NAMESPACE