Skip to content

Commit 335a0e1

Browse files
committed
docs: switch theme from furo to sphinx-book-theme
- 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
1 parent 628c698 commit 335a0e1

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

docs/conf.py

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -52,13 +52,15 @@
5252
# -- Options for HTML output -------------------------------------------------
5353
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
5454

55-
html_theme = "furo"
55+
html_theme = "sphinx_book_theme"
5656
html_static_path = ["_static"]
5757
html_theme_options = {
58-
"source_repository": "https://github.com/tanbro/redis_func_cache",
59-
"source_branch": "main",
60-
"source_directory": "docs/",
61-
"top_of_page_button": "edit",
58+
"path_to_docs": "docs/",
59+
"repository_url": "https://github.com/tanbro/redis_func_cache",
60+
"repository_branch": "main",
61+
"use_download_button": True,
62+
"use_fullscreen_button": True,
63+
"use_repository_button": True,
6264
}
6365

6466
# -- Options for autodoc ----------------------------------------------------

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,3 +56,4 @@ Indices and tables
5656

5757
* :ref:`genindex`
5858
* :ref:`modindex`
59+
* :ref:`search`

docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ importlib_metadata;python_version<"3.8"
22

33
Sphinx>=7
44
myst-parser
5-
furo
5+
sphinx-book-theme
66

77
sphinxcontrib-mermaid
88

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ docs = [
8585
"importlib_metadata;python_version<'3.8'",
8686
"Sphinx>=7",
8787
"myst-parser",
88-
"furo",
88+
"sphinx-book-theme",
8989
"sphinxcontrib-mermaid",
9090
"linkify-it-py",
9191
"sphinx-copybutton",

0 commit comments

Comments
 (0)