docs: switch theme from furo to sphinx-book-theme

tanbro · tanbro · commit 335a0e146aa5 · 2025-07-08T13:49:31.000+08:00
- Update html_theme to "sphinx_book_theme"
- Modify html_theme_options to use new theme settings
- Add search index to main page
- Update dependencies to replace furo with sphinx-book-theme
diff --git a/docs/conf.py b/docs/conf.py
@@ -52,13 +52,15 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "furo"
+html_theme = "sphinx_book_theme"
 html_static_path = ["_static"]
 html_theme_options = {
-    "source_repository": "https://github.com/tanbro/redis_func_cache",
-    "source_branch": "main",
-    "source_directory": "docs/",
-    "top_of_page_button": "edit",
+    "path_to_docs": "docs/",
+    "repository_url": "https://github.com/tanbro/redis_func_cache",
+    "repository_branch": "main",
+    "use_download_button": True,
+    "use_fullscreen_button": True,
+    "use_repository_button": True,
 }
 
 # -- Options for autodoc ----------------------------------------------------
diff --git a/docs/index.rst b/docs/index.rst
@@ -56,3 +56,4 @@ Indices and tables
 
 * :ref:`genindex`
 * :ref:`modindex`
+* :ref:`search`
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -2,7 +2,7 @@ importlib_metadata;python_version<"3.8"
 
 Sphinx>=7
 myst-parser
-furo
+sphinx-book-theme
 
 sphinxcontrib-mermaid
 
diff --git a/pyproject.toml b/pyproject.toml
@@ -85,7 +85,7 @@ docs = [
   "importlib_metadata;python_version<'3.8'",
   "Sphinx>=7",
   "myst-parser",
-  "furo",
+  "sphinx-book-theme",
   "sphinxcontrib-mermaid",
   "linkify-it-py",
   "sphinx-copybutton",

Original file line number	Diff line number	Diff line change
`@@ -56,3 +56,4 @@ Indices and tables`
`56`	`56`
`57`	`57`	* :ref:`genindex`
`58`	`58`	* :ref:`modindex`
	`59`	+* :ref:`search`