Switch docs to furo theme (#2492)

* Switch to docs to Furo theme

* Add logo and year

Co-authored-by: Igor Malinovskiy <igor.malinovskiy@redis.com>

4 files changed, 53 insertions, 14 deletions

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 0000000..936eb23
--- /dev/null
+++ b/docs/_static/redis-cube-red-white-rgb.svg
@@ -0,0 +1,30 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.0//EN" "http://www.w3.org/TR/2001/REC-SVG-20010904/DTD/svg10.dtd">
+<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" id="body_1" width="70" height="52">
+
+<defs>
+                <clipPath  id="1">
+
+                    <path clip-rule="evenodd" transform="matrix(1 0 0 1 0.01 0.01)"  d="M0 0L146.42 0L146.42 125.48L0 125.48z" />                </clipPath>
+</defs>
+
+<g transform="matrix(0.41404575 0 0 0.41404575 4.689784 -0)">
+	<g>
+		<g>
+			<g clip-path="url(#1)" >
+                <path transform="matrix(1 0 0 1 0.01 0.01)"  d="M140.66 96.74C 132.86 100.82 92.380005 117.47 83.66 122.03999C 74.94 126.609985 70.270004 126.479996 63.450005 123.21999C 56.630005 119.95999 13.7 102.5 5.92 98.78C 2 96.94 0 95.37 0 93.9L0 93.9L0 79.09C 0 79.09 56.08 66.92 65.13 63.64C 74.17999 60.36 77.31 60.28 85 63.1C 92.69 65.92 138.79 74.24 146.4 77L146.4 77L146.4 91.6C 146.4 93.119995 144.65 94.6 140.65999 96.729996L140.65999 96.729996L140.66 96.74z" stroke="none" fill="#A32422" fill-rule="nonzero" />
+                <path transform="matrix(1 0 0 1 0.01 0.01)"  d="M140.66 82C 132.86 86.06 92.380005 102.71 83.66 107.2C 74.94 111.689995 70.270004 111.649994 63.450005 108.399994C 56.630005 105.149994 13.7 87.69 5.92 84C -1.8599997 80.31 -2.0099998 77.73 5.62 74.75C 13.25 71.77 56.08 55 65.13 51.7C 74.17999 48.4 77.31 48.33 85 51.16C 92.69 53.989998 133 70 140.57 72.79C 148.14001 75.58 148.49 77.87 140.66 81.92L140.66 81.92L140.66 82z" stroke="none" fill="#DC382C" fill-rule="nonzero" />
+                <path transform="matrix(1 0 0 1 0.01 0.01)"  d="M140.66 72.62C 132.86 76.69 92.380005 93.33 83.66 97.82001C 74.94 102.31001 70.31 102.27 63.49 99C 56.670006 95.73 13.7 78.37 5.92 74.66C 2 72.8 0 71.24 0 69.76L0 69.76L0 55C 0 55 56.08 42.79 65.13 39.51C 74.17999 36.229996 77.31 36.14 85 39C 92.69 41.86 138.79 50.1 146.4 52.88L146.4 52.88L146.4 67.48C 146.4 69 144.65 70.52 140.66 72.62z" stroke="none" fill="#A32422" fill-rule="nonzero" />
+                <path transform="matrix(1 0 0 1 0.01 0.01)"  d="M140.66 57.81C 132.86 61.89 92.380005 78.53 83.66 83.020004C 74.94 87.51001 70.270004 87.48 63.450005 84.22C 56.630005 80.96 13.7 63.57 5.92 59.85C -1.8599997 56.129997 -2 53.6 5.62 50.62C 13.24 47.64 56.079998 30.829998 65.13 27.619999C 74.17999 24.41 77.31 24.21 85 27C 92.69 29.79 133 45.94 140.57 48.65C 148.14001 51.360004 148.49 53.74 140.66 57.780003L140.66 57.780003L140.66 57.81z" stroke="none" fill="#DC382C" fill-rule="nonzero" />
+                <path transform="matrix(1 0 0 1 0.01 0.01)"  d="M140.66 47.59C 132.86 51.67 92.380005 68.32 83.66 72.8C 74.94 77.28001 70.31 77.25 63.49 74C 56.670006 70.75 13.7 53.34 5.92 49.63C 2 47.79 0 46.22 0 44.74L0 44.74L0 29.93C 0 29.93 56.08 17.76 65.13 14.49C 74.17999 11.219999 77.31 11.12 85 13.94C 92.69 16.759998 138.77 25.08 146.38 27.86L146.38 27.86L146.38 42.46C 146.4 44 144.65 45.5 140.66 47.59z" stroke="none" fill="#A32422" fill-rule="nonzero" />
+                <path transform="matrix(1 0 0 1 0.01 0.01)"  d="M140.66 32.8C 132.86 36.8 92.380005 53.55 83.66 58C 74.94 62.45 70.270004 62.44 63.450005 59.2C 56.630005 55.960003 13.7 38.53 5.92 34.83C -1.8599997 31.130005 -2.0099998 28.560001 5.62 25.580002C 13.25 22.600002 56.08 5.8 65.13 2.54C 74.17999 -0.72000027 77.31 -0.82 85 2C 92.69 4.8199997 133 20.85 140.57 23.63C 148.14001 26.409998 148.49 28.72 140.66 32.77L140.66 32.77L140.66 32.8z" stroke="none" fill="#DC382C" fill-rule="nonzero" />
+			</g>
+            <path d="M75.51 11.78L85.17 8.61L82.55 14.87L92.38 18.55L79.71 19.87L76.86 26.71L72.28 19.08L57.63 17.76L68.57 13.82L65.28 7.76L75.51 11.78L75.51 11.78L75.51 11.78L75.51 11.78" stroke="none" fill="#FFFFFF" fill-rule="nonzero" />
+            <path d="M76.12 51.71L52.44 41.88L86.36 36.67L76.12 51.71L76.12 51.71L76.12 51.71L76.12 51.71" stroke="none" fill="#FFFFFF" fill-rule="nonzero" />
+            <path transform="matrix(1 0 0 1 0.01 0.01)"  d="M43.28 22.34C 53.28 22.34 61.409996 25.49 61.409996 29.34C 61.409996 33.190002 53.259995 36.34 43.28 36.34C 33.300003 36.34 25.14 33.19 25.14 29.34C 25.14 25.490002 33.27 22.34 43.28 22.34z" stroke="none" fill="#FFFFFF" fill-rule="nonzero" />
+            <path d="M107.39 20.42L127.46 28.35L107.41 36.28L107.39 20.42L107.39 20.42L107.39 20.42L107.39 20.42" stroke="none" fill="#741113" fill-rule="nonzero" />
+            <path d="M107.39 20.42L107.41 36.28L105.23 37.13L85.17 29.2L107.39 20.42L107.39 20.42L107.39 20.42L107.39 20.42" stroke="none" fill="#AC2724" fill-rule="nonzero" />
+		</g>
+	</g>
+</g>
+</svg>
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index 618d95a..a265e5c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -60,7 +60,7 @@ master_doc = "index"
 
 # 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 @@ exclude_patterns = ["_build", "**.ipynb_checkponts"]
 # 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 @@ nitpicky = True
 
 # 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": """
+            <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
+                <path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
+            </svg>
+        """,
+            "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 @@ html_theme_options = {
 
 # 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 @@ texinfo_documents = [
 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 7bcef53..6dd5379 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 23ddc94..edecdff 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