updates to documentation formatting

tylerhutcherson · tylerhutcherson · commit a921c035e169 · 2025-01-08T15:27:11.000-05:00
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -21,3 +21,6 @@ build:
 sphinx:
    configuration: docs/conf.py
 
+formats:
+  - pdf
+  - epub
diff --git a/docs/_static/gallery.yaml b/docs/_static/gallery.yaml
@@ -1,16 +1,17 @@
-
 - title: Arxiv Paper Search
-  website: https://docsearch.redisvl.com
-  img-bottom: ../_static/gallery-images/arxiv-search.png
+  website: https://github.com/redis-developer/redis-arxiv-search
+  # img-bottom: ../_static/gallery-images/arxiv-search.png
+- title: eCommerce Search
+  website: https://github.com/redis-developer/redis-product-search
 - title: Real-Time Embeddings with Redis and Bytewax
   website: https://github.com/awmatheson/real-time-embeddings
-  img-bottom: ../_static/gallery-images/bytewax-redis.png
-- title: Question and Answer with OpenAI
-  website: https://www.redisvl.com/docs/html/examples/openai_qna.html
-  img-bottom: ../_static/gallery-images/RedisOpenAI-QnA.png
+  # img-bottom: ../_static/gallery-images/bytewax-redis.png
+- title: Redis RAG Workbench
+  website: https://github.com/redis-developer/redis-rag-workbench
+  # img-bottom: ../_static/gallery-images/RedisOpenAI-QnA.png
 - title: LLM Recommender for Hotels
-  website: https://github.com/RedisVentures/LLM-Recommender
-  img-bottom: ../_static/gallery-images/hotel-recommender.png
-- title: Chat YOUR PDF
-  website: https://github.com/RedisVentures/gcp-redis-llm-stack/tree/main/examples/chat-your-pdf
-  img-bottom: ../_static/gallery-images/chat-your-pdf.png
+  website: https://github.com/redis-applied-ai/LLM-Recommender
+  # img-bottom: ../_static/gallery-images/hotel-recommender.png
+- title: Agentic RAG
+  website: https://github.com/redis-developer/agentic-rag
+  # img-bottom: ../_static/gallery-images/chat-your-pdf.png
diff --git a/docs/_static/js/sidebar.js b/docs/_static/js/sidebar.js
diff --git a/docs/_static/version_names.json b/docs/_static/version_names.json
diff --git a/docs/_templates/custom_sidebar.html b/docs/_templates/custom_sidebar.html
diff --git a/docs/_templates/versions.html b/docs/_templates/versions.html
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -7,8 +7,10 @@ myst:
 
 # RedisVL API
 
+Reference documentation for the RedisVL API.
+
 ```{toctree}
-:caption: RedisVL
+:caption: RedisVL API
 :maxdepth: 2
 
 schema
diff --git a/docs/conf.py b/docs/conf.py
@@ -72,8 +72,7 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
-html_css_files=["css/custom.css", "css/sidebar.css"]
-html_js_files=["js/sidebar.js"]
+html_css_files=["css/custom.css"]#, "css/sidebar.css"]
 html_title = "RedisVL"
 html_context = {
    "default_mode": "dark"
@@ -87,29 +86,24 @@
     "doc_path": "docs",
 }
 
-import redisvl
-version = redisvl.__version__
+
 # This allows us to use ::: to denote directives, useful for admonitions
 myst_enable_extensions = ["colon_fence"]
 myst_heading_anchors = 3
 
 html_theme_options = {
     "logo": {
         "text": "RedisVL",
-        "image_dark": "_static/redis-cube-red-white-rgb.svg",
+        "image_dark": "_static/Redis_Logo_Red_RGB.svg",
         "alt_text": "RedisVL",
     },
     "use_edit_page_button": True,
     "show_toc_level": 4,
-    "show_nav_level": 3,
+    "show_nav_level": 2,
     "navigation_depth": 5,
     "navbar_align": "content",  # [left, content, right] For testing that the navbar items align properly
-    "secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
-    "switcher": {
-        "json_url": "_static/version_names.json",
-        "version_match": version,
-    },
-    "navbar_start": ["navbar-logo", "version-switcher"],
+    #"secondary_sidebar_items": ["page-toc", "edit-this-page", "sourcelink"],
+    "navbar_start": ["navbar-logo"],
     "icon_links": [
         {
             "name": "GitHub",
@@ -120,9 +114,6 @@
     ]
 }
 
-html_sidebars = {
-    "**": ["custom_sidebar.html"]
-}
 
 autoclass_content = 'both'
 add_module_names = False
diff --git a/docs/examples/index.md b/docs/examples/index.md
@@ -8,6 +8,8 @@ myst:
 
 # Example Gallery
 
+Explore community examples of RedisVL in the wild.
+
 ```{note}
 If you are using RedisVL, please consider adding your example to this page by
 opening a Pull Request on [GitHub](https://github.com/redis/redis-vl-python)
@@ -17,9 +19,3 @@ opening a Pull Request on [GitHub](https://github.com/redis/redis-vl-python)
 :grid-columns: "1 1 2 2"
 ```
 
-```{toctree}
-:hidden:
-
-openai_qna
-
-```
diff --git a/docs/index.md b/docs/index.md
@@ -47,7 +47,6 @@ docker run -d --name redis -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
 
 This will also spin up the [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
 
-> Read more about `redisvl` installation [here](https://redisvl.com/overview/installation.html)
 
 ## Table of Contents
 
diff --git a/docs/overview/cli.ipynb b/docs/overview/cli.ipynb
@@ -37,7 +37,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Index\n",
+    "## Index\n",
     "\n",
     "The ``rvl index`` command can be used for a number of tasks related to creating and managing indices. Whether you are working in Python or another language, this cli tool can still be useful for managing and inspecting your indices.\n",
     "\n",
diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md
@@ -6,9 +6,10 @@ myst:
 ---
 
 # User Guides
-
+User guides provide helpful resources for using RedisVL and its different components.
 
 ```{toctree}
+:caption: User Guides
 :maxdepth: 2
 
 getting_started_01
@@ -19,5 +20,5 @@ hash_vs_json_05
 rerankers_06
 session_manager_07
 semantic_router_08
+openai_qna_09
 ```
-
diff --git a/docs/user_guide/openai_qna_09.ipynb b/docs/user_guide/openai_qna_09.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Question and Answer with OpenAI and RedisVL\n",
+    "# RAG with OpenAI and RedisVL\n",
     "\n",
     "This example shows how to use RedisVL to create a question and answer system using OpenAI's API.\n",
     "\n",

Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,6 @@ docker run -d --name redis -p 6379:6379 -p 8001:8001 redis/redis-stack:latest`
`47`	`47`
`48`	`48`	This will also spin up the [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
`49`	`49`
`50`		-> Read more about `redisvl` installation [here](https://redisvl.com/overview/installation.html)
`51`	`50`
`52`	`51`	`## Table of Contents`
`53`	`52`