From 1e1196a14ac25ca8e3c4c2c3f61bf0e4ff762d6c Mon Sep 17 00:00:00 2001 From: Sam Partee Date: Wed, 26 Jul 2023 14:02:06 -0700 Subject: [PATCH] Documentation Update --- docs/_static/css/custom.css | 3 +++ docs/_static/redis-cube-red-white-rgb.svg | 1 + docs/conf.py | 8 +++++++- docs/index.md | 2 +- 4 files changed, 12 insertions(+), 2 deletions(-) create mode 100644 docs/_static/redis-cube-red-white-rgb.svg diff --git a/docs/_static/css/custom.css b/docs/_static/css/custom.css index e69de29b..ce989d9a 100644 --- a/docs/_static/css/custom.css +++ b/docs/_static/css/custom.css @@ -0,0 +1,3 @@ +.logo__image { + transform: scale(.7); +} \ No newline at end of file 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 00000000..25583faa --- /dev/null +++ b/docs/_static/redis-cube-red-white-rgb.svg @@ -0,0 +1 @@ + \ No newline at end of file diff --git a/docs/conf.py b/docs/conf.py index 39b5e207..d1c16dcc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -72,7 +72,8 @@ html_context = { "default_mode": "dark" } - +html_logo = "_static/redis-cube-red-white-rgb.svg" +html_favicon = "_static/redis-cube-red-white-rgb.svg" html_context = { "github_user": "RedisVentures", "github_repo": "RedisVL", @@ -85,6 +86,11 @@ myst_heading_anchors = 2 html_theme_options = { + "logo": { + "text": "RedisVL", + "image_dark": "_static/redis-cube-red-white-rgb.svg", + "alt_text": "RedisVL", + }, "use_edit_page_button": True, "show_toc_level": 1, "navbar_align": "left", # [left, content, right] For testing that the navbar items align properly diff --git a/docs/index.md b/docs/index.md index 10e0c183..c9d13776 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ myst: "description lang=en": | Top-level documentation for RedisVL, with links to the rest of the site.. -html_theme.sidebar_secondary.remove: true +html_theme.sidebar_secondary.remove: false --- # Redis Vector Library (RedisVL)