Set *Sphinx* doc theme to *furo*

Set the theme for *Sphinx* doc to *furo*: https://pypi.org/project/furo/
fabcor-maxiv · Oct 18, 2023 · 8d50266 · 8d50266
1 parent 397df83
commit 8d50266
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 12 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -25,8 +25,6 @@
 version = PROJECT_PACKAGE_METADATA["Version"]
 release = version
 
-DOCUMENT_DESCRIPTION = f"{project} documentation"
-
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -46,15 +44,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "alabaster"
-
-html_theme_options = {
-    "description": DOCUMENT_DESCRIPTION,
-    "github_banner": "true",
-    "github_button": "true",
-    "github_repo": "mxcubecore",
-    "github_user": "mxcube",
-}
+html_theme = "furo"
 
 
 # -- Extensions --------------------------------------------------------------

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -62,6 +62,7 @@ pytest-mock = "^3.10.0"
 [tool.poetry.group.docs.dependencies]
 myst-parser = "^2.0.0"
 sphinx = "<7.2"
+furo = "^2023.9.10"
 
 [tool.poetry.extras]
 tango = ["PyTango"]