Upgrade to readthedocs.org documentation (#256)

This PR moves the documentation hosting to RTD!

Author: tylerhutcherson

.docs_static/.nojekyll

@@ -93,7 +93,7 @@ jobs:
         AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
         AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
       run: |
-        cd docs/ && poetry run treon -v --exclude="./examples/openai_qna.ipynb"
+        cd docs/ && poetry run treon -v
 
     - name: Publish coverage results
       uses: codecov/codecov-action@v4

.docs_static/CNAME

@@ -0,0 +1,26 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.11"
+  jobs:
+    post_create_environment:
+      # Install poetry
+      - python -m pip install poetry==1.8.3
+    post_install:
+      # Install dependencies
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install --with docs
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+formats:
+  - pdf
+  - epub

.docs_static/index.html

@@ -87,13 +87,13 @@ 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/):
+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.io/cloud/) or locally in docker with [Redis Stack](https://redis.io/docs/latest/operate/oss_and_stack/install/install-stack/docker/):
 
 ```bash
 docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
 ```
 
-This will also spin up the [FREE RedisInsight GUI](https://redis.com/redis-enterprise/redis-insight/) at `http://localhost:8001`.
+This will also spin up the [FREE RedisInsight GUI](https://redis.io/insight/) at `http://localhost:8001`.
 
 ## How to Report a Bug
 

.github/workflows/run_tests.yml

@@ -21,7 +21,7 @@
 <div align="center">
 <div display="inline-block">
     <a href="https://github.com/redis/redis-vl-python"><b>Home</b></a>&nbsp;&nbsp;&nbsp;
-    <a href="https://www.redisvl.com"><b>Documentation</b></a>&nbsp;&nbsp;&nbsp;
+    <a href="https://docs.redisvl.com"><b>Documentation</b></a>&nbsp;&nbsp;&nbsp;
     <a href="https://github.com/redis-developer/redis-ai-resources"><b>Recipes</b></a>&nbsp;&nbsp;&nbsp;
   </div>
     <br />
@@ -49,7 +49,7 @@ Install `redisvl` into your Python (>=3.8) environment using `pip`:
 ```bash
 pip install redisvl
 ```
-> For more detailed instructions, visit the [installation guide](https://www.redisvl.com/overview/installation.html).
+> For more detailed instructions, visit the [installation guide](https://docs.redisvl.com/en/latest/overview/installation.html).
 
 ## Setting up Redis
 
@@ -62,16 +62,16 @@ Choose from multiple Redis deployment options:
     docker run -d --name redis-stack -p 6379:6379 -p 8001:8001 redis/redis-stack:latest
     ```
 3. [Redis Enterprise](https://redis.io/enterprise/): Commercial, self-hosted database
-4. [Azure Cache for Redis Enterprise](https://learn.microsoft.com/azure/azure-cache-for-redis/quickstart-create-redis-enterprise): Fully managed Redis Enterprise on Azure
+4. [Azure Managed Redis](https://azure.microsoft.com/en-us/products/managed-redis): Fully managed Redis Enterprise on Azure
 
-> Enhance your experience and observability with the free [Redis Insight GUI](https://redis.com/redis-enterprise/redis-insight/).
+> Enhance your experience and observability with the free [Redis Insight GUI](https://redis.io/insight/).
 
 
 # Overview
 
 
 ## 🗃️ Redis Index Management
-1. [Design a schema for your use case](https://www.redisvl.com/user_guide/getting_started_01.html#define-an-indexschema) that models your dataset with built-in Redis  and indexable fields (*e.g. text, tags, numerics, geo, and vectors*). [Load a schema](https://www.redisvl.com/user_guide/getting_started_01.html#example-schema-creation) from a YAML file:
+1. [Design a schema for your use case](https://docs.redisvl.com/en/latest/user_guide/getting_started_01.html#define-an-indexschema) that models your dataset with built-in Redis  and indexable fields (*e.g. text, tags, numerics, geo, and vectors*). [Load a schema](https://docs.redisvl.com/en/latest/user_guide/getting_started_01.html#example-schema-creation) from a YAML file:
     ```yaml
     index:
       name: user-idx
@@ -121,7 +121,7 @@ Choose from multiple Redis deployment options:
     })
     ```
 
-2. [Create a SearchIndex](https://www.redisvl.com/user_guide/getting_started_01.html#create-a-searchindex) class with an input schema and client connection in order to perform admin and search operations on your index in Redis:
+2. [Create a SearchIndex](https://docs.redisvl.com/en/latest/user_guide/getting_started_01.html#create-a-searchindex) class with an input schema and client connection in order to perform admin and search operations on your index in Redis:
     ```python
     from redis import Redis
     from redisvl.index import SearchIndex
@@ -133,10 +133,10 @@ Choose from multiple Redis deployment options:
     # Create the index in Redis
     index.create()
     ```
-    > Async compliant search index class also available: [AsyncSearchIndex](https://www.redisvl.com/api/searchindex.html#redisvl.index.AsyncSearchIndex).
+    > Async compliant search index class also available: [AsyncSearchIndex](https://docs.redisvl.com/en/latest/api/searchindex.html#redisvl.index.AsyncSearchIndex).
 
-3. [Load](https://www.redisvl.com/user_guide/getting_started_01.html#load-data-to-searchindex)
-and [fetch](https://www.redisvl.com/user_guide/getting_started_01.html#fetch-an-object-from-redis) data to/from your Redis instance:
+3. [Load](https://docs.redisvl.com/en/latest/user_guide/getting_started_01.html#load-data-to-searchindex)
+and [fetch](https://docs.redisvl.com/en/latest/user_guide/getting_started_01.html#fetch-an-object-from-redis) data to/from your Redis instance:
     ```python
     data = {"user": "john", "credit_score": "high", "embedding": [0.23, 0.49, -0.18, 0.95]}
 
@@ -151,7 +151,7 @@ and [fetch](https://www.redisvl.com/user_guide/getting_started_01.html#fetch-an-
 
 Define queries and perform advanced searches over your indices, including the combination of vectors, metadata filters, and more.
 
-- [VectorQuery](https://www.redisvl.com/api/query.html#vectorquery) - Flexible vector queries with customizable filters enabling semantic search:
+- [VectorQuery](https://docs.redisvl.com/en/latest/api/query.html#vectorquery) - Flexible vector queries with customizable filters enabling semantic search:
 
     ```python
     from redisvl.query import VectorQuery
@@ -179,24 +179,24 @@ Define queries and perform advanced searches over your indices, including the co
     results = index.query(query)
     ```
 
-- [RangeQuery](https://www.redisvl.com/api/query.html#rangequery) - Vector search within a defined range paired with customizable filters
-- [FilterQuery](https://www.redisvl.com/api/query.html#filterquery) - Standard search using filters and the full-text search
-- [CountQuery](https://www.redisvl.com/api/query.html#countquery) - Count the number of indexed records given attributes
+- [RangeQuery](https://docs.redisvl.com/en/latest/api/query.html#rangequery) - Vector search within a defined range paired with customizable filters
+- [FilterQuery](https://docs.redisvl.com/en/latest/api/query.html#filterquery) - Standard search using filters and the full-text search
+- [CountQuery](https://docs.redisvl.com/en/latest/api/query.html#countquery) - Count the number of indexed records given attributes
 
-> Read more about building [advanced Redis queries](https://www.redisvl.com/user_guide/hybrid_queries_02.html).
+> Read more about building [advanced Redis queries](https://docs.redisvl.com/en/latest/user_guide/hybrid_queries_02.html).
 
 
 ## 🔧  Utilities
 
 ### Vectorizers
 Integrate with popular embedding providers to greatly simplify the process of vectorizing unstructured data for your index and queries:
-- [AzureOpenAI](https://www.redisvl.com/api/vectorizer.html#azureopenaitextvectorizer)
-- [Cohere](https://www.redisvl.com/api/vectorizer.html#coheretextvectorizer)
-- [Custom](https://www.redisvl.com/api/vectorizer.html#customtextvectorizer)
-- [GCP VertexAI](https://www.redisvl.com/api/vectorizer.html#vertexaitextvectorizer)
-- [HuggingFace](https://www.redisvl.com/api/vectorizer.html#hftextvectorizer)
-- [Mistral](https://www.redisvl.com/api/vectorizer/html#mistralaitextvectorizer)
-- [OpenAI](https://www.redisvl.com/api/vectorizer.html#openaitextvectorizer)
+- [AzureOpenAI](https://docs.redisvl.com/en/latest/api/vectorizer.html#azureopenaitextvectorizer)
+- [Cohere](https://docs.redisvl.com/en/latest/api/vectorizer.html#coheretextvectorizer)
+- [Custom](https://docs.redisvl.com/en/latest/api/vectorizer.html#customtextvectorizer)
+- [GCP VertexAI](https://docs.redisvl.com/en/latest/api/vectorizer.html#vertexaitextvectorizer)
+- [HuggingFace](https://docs.redisvl.com/en/latest/api/vectorizer.html#hftextvectorizer)
+- [Mistral](https://docs.redisvl.com/en/latest/api/vectorizer/html#mistralaitextvectorizer)
+- [OpenAI](https://docs.redisvl.com/en/latest/api/vectorizer.html#openaitextvectorizer)
 
 ```python
 from redisvl.utils.vectorize import CohereTextVectorizer
@@ -215,11 +215,11 @@ embeddings = co.embed_many(
 )
 ```
 
-> Learn more about using [vectorizers]((https://www.redisvl.com/user_guide/vectorizers_04.html)) in your embedding workflows.
+> Learn more about using [vectorizers]((https://docs.redisvl.com/en/latest/user_guide/vectorizers_04.html)) in your embedding workflows.
 
 
 ### Rerankers
-[Integrate with popular reranking providers](https://www.redisvl.com/user_guide/rerankers_06.html) to improve the relevancy of the initial search results from Redis
+[Integrate with popular reranking providers](https://docs.redisvl.com/en/latest/user_guide/rerankers_06.html) to improve the relevancy of the initial search results from Redis
 
 
 
@@ -229,7 +229,7 @@ We're excited to announce the support for **RedisVL Extensions**. These modules
 *Have an idea for another extension? Open a PR or reach out to us at [email protected]. We're always open to feedback.*
 
 ### LLM Semantic Caching
-Increase application throughput and reduce the cost of using LLM models in production by leveraging previously generated knowledge with the [`SemanticCache`](https://www.redisvl.com/api/cache.html#semanticcache).
+Increase application throughput and reduce the cost of using LLM models in production by leveraging previously generated knowledge with the [`SemanticCache`](https://docs.redisvl.com/en/latest/api/cache.html#semanticcache).
 
 ```python
 from redisvl.extensions.llmcache import SemanticCache
@@ -256,11 +256,11 @@ print(response[0]["response"])
 >>> Paris
 ```
 
-> Learn more about [semantic caching]((https://www.redisvl.com/user_guide/llmcache_03.html)) for LLMs.
+> Learn more about [semantic caching]((https://docs.redisvl.com/en/latest/user_guide/llmcache_03.html)) for LLMs.
 
 ### LLM Session Management
 
-Improve personalization and accuracy of LLM responses by providing user chat history as context. Manage access to the session data using recency or relevancy, *powered by vector search* with the [`SemanticSessionManager`](https://www.redisvl.com/api/session_manager.html).
+Improve personalization and accuracy of LLM responses by providing user chat history as context. Manage access to the session data using recency or relevancy, *powered by vector search* with the [`SemanticSessionManager`](https://docs.redisvl.com/en/latest/api/session_manager.html).
 
 ```python
 from redisvl.extensions.session_manager import SemanticSessionManager
@@ -292,7 +292,7 @@ session.get_relevant("weather", top_k=1)
 ```stdout
 >>> [{"role": "user", "content": "what is the weather going to be today?"}]
 ```
-> Learn more about [LLM session management]((https://www.redisvl.com/user_guide/session_manager_07.html)).
+> Learn more about [LLM session management]((https://docs.redisvl.com/en/latest/user_guide/session_manager_07.html)).
 
 
 ### LLM Semantic Routing
@@ -329,7 +329,7 @@ router("Hi, good morning")
 ```stdout
 >>> RouteMatch(name='greeting', distance=0.273891836405)
 ```
-> Learn more about [semantic routing](https://www.redisvl.com/user_guide/semantic_router_08.html).
+> Learn more about [semantic routing](https://docs.redisvl.com/en/latest/user_guide/semantic_router_08.html).
 
 ## 🖥️ Command Line Interface
 Create, destroy, and manage Redis index configurations from a purpose-built CLI interface: `rvl`.
@@ -345,7 +345,7 @@ Commands:
         stats       Obtain statistics about an index
 ```
 
-> Read more about [using the CLI](https://www.redisvl.com/user_guide/cli.html).
+> Read more about [using the CLI](https://docs.redisvl.com/en/latest/user_guide/cli.html).
 
 ## 🚀 Why RedisVL?
 
@@ -359,9 +359,9 @@ The Redis Vector Library bridges the gap between the AI-native developer ecosyst
 ## 😁 Helpful Links
 
 For additional help, check out the following resources:
- - [Getting Started Guide](https://www.redisvl.com/user_guide/getting_started_01.html)
- - [API Reference](https://www.redisvl.com/api/index.html)
- - [Example Gallery](https://www.redisvl.com/examples/index.html)
+ - [Getting Started Guide](https://docs.redisvl.com/en/latest/user_guide/getting_started_01.html)
+ - [API Reference](https://docs.redisvl.com/en/latest/api/index.html)
+ - [Example Gallery](https://docs.redisvl.com/en/latest/examples/index.html)
  - [Redis AI Recipes](https://github.com/redis-developer/redis-ai-resources)
  - [Official Redis Vector API Docs](https://redis.io/docs/interact/search-and-query/advanced-concepts/vectors/)
 
@@ -371,4 +371,4 @@ For additional help, check out the following resources:
 Please help us by contributing PRs, opening GitHub issues for bugs or new feature ideas, improving documentation, or increasing test coverage. [Read more about how to contribute!](CONTRIBUTING.md)
 
 ## 🚧 Maintenance
-This project is supported by [Redis, Inc](https://redis.com) on a good faith effort basis. To report bugs, request features, or receive assistance, please [file an issue](https://github.com/redis/redis-vl-python/issues).
+This project is supported by [Redis, Inc](https://redis.io) on a good faith effort basis. To report bugs, request features, or receive assistance, please [file an issue](https://github.com/redis/redis-vl-python/issues).

.readthedocs.yaml

@@ -1,16 +1,12 @@
-
 - 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
+- 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
+- title: Redis RAG Workbench
+  website: https://github.com/redis-developer/redis-rag-workbench
 - 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
+- title: Agentic RAG
+  website: https://github.com/redis-developer/agentic-rag