diff options
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 31 |
1 files changed, 20 insertions, 11 deletions
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" |