Repackage documentation and apply poetry updates (#146)

Improves VL documentation with new Redis logos, poetry scripting, poetry docs dependencies, and also adds new reranking user guide.
redis · May 1, 2024 · 7faaf4e · 7faaf4e
1 parent 4cd53d0
commit 7faaf4e
Show file tree

Hide file tree

Showing 22 changed files with 1,240 additions and 327 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -38,7 +38,6 @@ Then install the required libraries:
 poetry install --all-extras
 ```
 
-
 ### Linting and Tests
 
 Check formatting, linting, and typing:
@@ -58,7 +57,7 @@ To run Testcontainers-based tests you need a local Docker installation such as:
 
 #### Running the Tests
 
-Tests (with vectorizers):
+Tests w/ vectorizers:
 ```bash
 poetry run test-cov
 ```
@@ -73,6 +72,19 @@ Tests w/out rerankers:
 SKIP_RERANKERS=true poetry run test-cov
 ```
 
+### Documentation
+Docs are served from the `docs/` directory.
+
+Build the docs. Generates the `_build/html` contents:
+```bash
+poetry run build-docs
+```
+
+Serve the documentation with a local webserver:
+```bash
+poetry run serve-docs
+```
+
 ### Getting Redis
 
 In order for your applications to use RedisVL, you must have [Redis](https://redis.io) accessible with Search & Query features enabled on [Redis Cloud](https://redis.com/try-free) or locally in docker with [Redis Stack](https://redis.io/docs/getting-started/install-stack/docker/):

diff --git a/docs/_static/Redis_Favicon_144x144_Red.png b/docs/_static/Redis_Favicon_144x144_Red.png
diff --git a/docs/_static/Redis_Favicon_16x16_Red.png b/docs/_static/Redis_Favicon_16x16_Red.png
diff --git a/docs/_static/Redis_Favicon_32x32_Red.png b/docs/_static/Redis_Favicon_32x32_Red.png
diff --git a/docs/_static/Redis_Logo_Red_RGB.svg b/docs/_static/Redis_Logo_Red_RGB.svg
diff --git a/docs/_static/android-chrome-192x192.png b/docs/_static/android-chrome-192x192.png
diff --git a/docs/_static/android-chrome-512x512.png b/docs/_static/android-chrome-512x512.png
diff --git a/docs/_static/apple-touch-icon.png b/docs/_static/apple-touch-icon.png
diff --git a/docs/_static/favicon-16x16.png b/docs/_static/favicon-16x16.png
diff --git a/docs/_static/favicon-32x32.png b/docs/_static/favicon-32x32.png
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
diff --git a/docs/_static/js/sidebar.js b/docs/_static/js/sidebar.js
@@ -9,6 +9,7 @@ const toc = [
         { title: "Query and Filter", path: "/user_guide/hybrid_queries_02.html" },
         { title: "JSON vs Hash Storage", path: "/user_guide/hash_vs_json_05.html" },
         { title: "Vectorizers", path: "/user_guide/vectorizers_04.html" },
+        { title: "Rerankers", path: "/user_guide/rerankers_06.html"},
         { title: "Semantic Caching", path: "/user_guide/llmcache_03.html" },
     ]},
     { header: "API", toc: [
@@ -17,6 +18,7 @@ const toc = [
         { title: "Query", path: "/api/query.html" },
         { title: "Filter", path: "/api/filter.html" },
         { title: "Vectorizers", path: "/api/vectorizer.html" },
+        { title: "Rerankers", path: "/api/reranker.html" },
         { title: "LLMCache", path: "/api/cache.html" }
     ]}
 ];

diff --git a/docs/_static/redis-cube-red-white-rgb.svg b/docs/_static/redis-cube-red-white-rgb.svg
diff --git a/docs/_static/site.webmanifest b/docs/_static/site.webmanifest
@@ -1 +1 @@
-{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}
+{"name":"","short_name":"","icons":[{"src":"Redis_Favicon_144x144_Red.png","sizes":"144x144","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}
diff --git a/docs/conf.py b/docs/conf.py
@@ -76,8 +76,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_logo = "_static/Redis_Favicon_32x32_Red.png"
+html_favicon = "_static/Redis_Favicon_32x32_Red.png"
 html_context = {
     "github_user": "RedisVentures",
     "github_repo": "RedisVL",
@@ -145,13 +145,10 @@
 
 # see https://sphinx-favicon.readthedocs.io for more information about the
 # sphinx-favicon extension
+
 favicons = [
     # generic icons compatible with most browsers
-    "favicon-32x32.png",
-    "favicon-16x16.png",
-    {"rel": "shortcut icon", "sizes": "any", "href": "favicon.ico"},
-    # chrome specific
-    "android-chrome-192x192.png",
-    # apple icons
-    {"rel": "apple-touch-icon", "href": "apple-touch-icon.png"},
+    "Redis_Favicon_32x32_Red.png",
+    "Redis_Favicon_16x16_Red.png",
+    "Redis_Favicon_144x144_Red.png",
 ]
diff --git a/docs/requirements-doc.txt b/docs/requirements-doc.txt
diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md
@@ -16,5 +16,6 @@ hybrid_queries_02
 llmcache_03
 vectorizers_04
 hash_vs_json_05
+rerankers_06
 ```
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"name":"","short_name":"","icons":[{"src":"/android-chrome-192x192.png","sizes":"192x192","type":"image/png"},{"src":"/android-chrome-512x512.png","sizes":"512x512","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}
		{"name":"","short_name":"","icons":[{"src":"Redis_Favicon_144x144_Red.png","sizes":"144x144","type":"image/png"}],"theme_color":"#ffffff","background_color":"#ffffff","display":"standalone"}