furo doc

bentheiii · Dec 14, 2023 · 7ae9053 · 7ae9053
1 parent 89a0b6d
commit 7ae9053
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 4 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,7 @@
 # envolved Changelog
+## Next
+### Docs
+* changed documentation theme with furo
 ## 1.1.2
 ### Fixed
 * changed type of `args` to be an invariant `Mapping` instead of a `dict`

diff --git a/docs/conf.py b/docs/conf.py
@@ -141,9 +141,13 @@ def find_source():
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 
-html_theme_options = {"vcs_pageview_mode": "edit"}
+html_theme_options = {
+    "source_repository": "https://github.com/biocatchltd/yellowbox",
+    "source_branch": "master",
+    "source_directory": "docs/",
+}
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/docs/requirements.txt b/docs/requirements.txt
diff --git a/pyproject.toml b/pyproject.toml
@@ -17,7 +17,7 @@ python = "^3.7"
 [tool.poetry.group.dev.dependencies]
 pytest = "*"
 sphinx = {version="^7", python = ">=3.12"}
-sphinx-rtd-theme = {version="*", python = ">=3.12"}
+furo = {version="*", python = ">=3.12"}
 mypy = "*"
 pytest-cov = "^4.1.0"
 ruff = "*"