Merge pull request #15 from cyberstudio/add-docs-theme

Add sphinx_book_theme
cyberstudio · Oct 7, 2023 · c84a005 · c84a005
2 parents ad5f006 + 18c0b5b
commit c84a005
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 6 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -20,7 +20,6 @@
     "sphinx.ext.todo",
     "sphinx.ext.viewcode",
     "enum_tools.autoenum",
-    "sphinxjp.themes.basicstrap",
 ]
 
 # A list of regular expressions that match anchors Sphinx should skip
@@ -77,9 +76,13 @@
 
 # -- Options for HTML output ----------------------------------------------
 
-html_theme = 'basicstrap'
+# Docs of sphinx_book_theme https://pydata-sphinx-theme.readthedocs.io/en/latest/user_guide/install.html
+html_theme = 'sphinx_book_theme'
 html_theme_options = {
-    'sidebar_span': 1,
+    "repository_url": "https://github.com/cyberstudio/cybsi-cloud-sdk",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    'secondary_sidebar_items': [],
 }
 html_static_path = ["_static"]
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -4,7 +4,7 @@ Sphinx==4.2.0
 sphinx_toolbox==2.16.0
 sphinx-autodoc-typehints==1.11.1
 enum_tools==0.11.0
-sphinxjp.themes.basicstrap==0.5.0
+sphinx-book-theme==1.0.1
 httpx==0.23.1
 sphinx-jinja2-compat==0.1.1
 aiofiles==22.1.0
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -26,7 +26,7 @@ Sphinx = "4.2.0"
 sphinx-autodoc-typehints = "1.11.1"
 sphinx-jinja2-compat = "0.1.1"
 sphinx_toolbox = "2.16.0"
-"sphinxjp.themes.basicstrap" = "0.5.0"
+sphinx-book-theme = "^1.0.1"
 pytest = "^7.1.1"
 tbump = "6.8.0"