Merge pull request #158 from JOJ0/dev

Docs theme change

doc/source/_static/synadm.css

@@ -0,0 +1,11 @@
+html {
+    --pst-font-size-base: 14px;
+    --pst-header-height: 3rem;
+}
+
+@media (prefers-reduced-motion) {
+    .bd-sidebar-primary, .bd-sidebar-secondary {
+        transition-duration: 0s;
+    }
+}
+

doc/source/conf.py

@@ -56,23 +56,36 @@
 
 
 # -- Options for HTML output -------------------------------------------------
+html_theme = "pydata_sphinx_theme"
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
-html_theme = 'sphinx_rtd_theme'
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
-
+html_context = {
+    "github_user": "JOJ0",
+    "github_repo": "synadm",
+    "github_version": "master",
+    "doc_path": "doc/source/",
+}
 html_theme_options = {
-    'collapse_navigation': True,
-    'navigation_depth': 8,
-    'sticky_navigation': False,
-    'prev_next_buttons_location': 'bottom'
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/JOJ0/synadm",
+            "icon": "fa-brands fa-github",
+        },
+    ],
+    "use_edit_page_button": True,
+
+    # this is a weird hack that makes site headers not overflow (and be
+    # problematic), avoid changing without checking if the site header
+    # became bigger!
+    "navbar_align": "left",
+
+    "header_links_before_dropdown": 3,
+    "show_toc_level": 3,
+    "back_to_top_button": False,
 }
+html_title = "synadm"
+html_static_path = ["_static"]
+html_css_files = ["synadm.css"]
 
 
 # -- Extension configuration -------------------------------------------------

rtd_requirements.txt

@@ -21,7 +21,7 @@ requests==2.31.0
 snowballstemmer==2.2.0
 Sphinx==7.2.3
 sphinx-click==5.0.1
-sphinx-rtd-theme==1.3.0
+pydata-sphinx-theme==0.15.4
 sphinxcontrib-applehelp==1.0.7
 sphinxcontrib-devhelp==1.0.5
 sphinxcontrib-htmlhelp==2.0.4

sphinx_requirements.txt

@@ -1,5 +1,5 @@
 Jinja2<3.1
 Sphinx
 sphinx-click
-sphinx-rtd-theme
+pydata-sphinx-theme
 myst-parser