Using furo theme for Sphinx docs

TexZK · Dec 1, 2023 · 9151613 · 9151613
1 parent caf5a06
commit 9151613
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 12 deletions.
diff --git a/docs/_static/.keep b/docs/_static/.keep
diff --git a/docs/_static/css/my_theme.css b/docs/_static/css/my_theme.css
diff --git a/docs/conf.py b/docs/conf.py
@@ -43,21 +43,27 @@ def read_version():
     'issue': ('https://github.com/TexZK/hexrec/issues/%s', '#'),
     'pr': ('https://github.com/TexZK/hexrec/pull/%s', 'PR #'),
 }
+
 # on_rtd is whether we are on readthedocs.org
-on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+#on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
 
-if not on_rtd:  # only set the theme if we're building docs locally
-    html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 
 html_use_smartypants = True
 html_last_updated_fmt = '%Y-%m-%d'
 html_split_index = False
 html_sidebars = {
-   '**': ['searchbox.html', 'globaltoc.html', 'sourcelink.html'],
+    "**": [
+        "sidebar/scroll-start.html",
+        "sidebar/brand.html",
+        "sidebar/search.html",
+        "sidebar/navigation.html",
+        "sidebar/ethical-ads.html",
+        "sidebar/scroll-end.html",
+    ],
 }
 html_short_title = f'{project}-{version}'
 html_static_path = ['_static']
-html_style = 'css/my_theme.css'
 
 autosummary_generate = True
 autosummary_generate_overwrite = True

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,6 +1,6 @@
-sphinx >= 6
-sphinx-rtd-theme
+sphinx >= 7
 sphinx-click
 sphinx-autodoc-typehints
+furo
 twine
 -e .