diff --git a/docs/_static/redis-cube-red-white-rgb.svg b/docs/_static/redis-cube-red-white-rgb.svg
new file mode 100644
index 0000000000..936eb231b9
--- /dev/null
+++ b/docs/_static/redis-cube-red-white-rgb.svg
@@ -0,0 +1,30 @@
+
+
+
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index 618d95aea1..a265e5cc2f 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -60,7 +60,7 @@
# General information about the project.
project = "redis-py"
-copyright = "2021, Redis Inc"
+copyright = "2022, Redis Inc"
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
@@ -104,7 +104,7 @@
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = "sphinx"
+pygments_style = "tango"
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@@ -116,19 +116,28 @@
# 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"
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"display_version": True,
- "prev_next_buttons_location": "bottom",
- "style_external_links": False,
- # Toc options
- "collapse_navigation": True,
- "sticky_navigation": True,
- "navigation_depth": 4,
+ "footer_icons": [
+ {
+ "name": "GitHub",
+ "url": "https://github.com/redis/redis-py",
+ "html": """
+
+ """,
+ "class": "",
+ },
+ ],
+ "source_repository": "https://github.com/redis/redis-py/",
+ "source_branch": "master",
+ "source_directory": "docs/",
}
# Add any paths that contain custom themes here, relative to this directory.
@@ -143,7 +152,7 @@
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
-# html_logo = None
+html_logo = "_static/redis-cube-red-white-rgb.svg"
# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
@@ -278,4 +287,4 @@
epub_title = "redis-py"
epub_author = "Redis Inc"
epub_publisher = "Redis Inc"
-epub_copyright = "2021, Redis Inc"
+epub_copyright = "2022, Redis Inc"
diff --git a/docs/index.rst b/docs/index.rst
index 7bcef53466..6dd537948e 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -3,7 +3,7 @@
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
-Welcome to redis-py's documentation!
+redis-py - Python Client for Redis
====================================
Getting Started
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 23ddc948f4..edecdffe4b 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,7 +1,7 @@
-sphinx<5
+sphinx>=5.0,<7.0
docutils<0.18
-sphinx-rtd-theme
nbsphinx
sphinx_gallery
ipython
sphinx-autodoc-typehints
+furo