Update docs: add hf reranker, fix github links and searchindex links (#…

…246) Misc documentation updates: - Add missing HFCrossEncoderReranker to API docs - Fix internal (anchor) links in Search Index API docs - Fix "edit on GitHub" link
redis · Nov 26, 2024 · b954656 · b954656
1 parent acf3c66
commit b954656
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 8 deletions.
diff --git a/docs/api/reranker.rst b/docs/api/reranker.rst
@@ -12,3 +12,15 @@ CohereReranker
 .. autoclass:: CohereReranker
    :show-inheritance:
    :members:
+
+
+HFCrossEncoderReranker
+========================
+
+.. _hfcrossencoderreranker_api:
+
+.. currentmodule:: redisvl.utils.rerank.hf_cross_encoder
+
+.. autoclass:: HFCrossEncoderReranker
+   :show-inheritance:
+   :members:
diff --git a/docs/api/searchindex.rst b/docs/api/searchindex.rst
@@ -8,27 +8,27 @@ Search Index Classes
 
    * - Class
      - Description
-   * - `SearchIndex <#searchindex_api>`_
+   * - :ref:`searchindex_api`
      - Primary class to write, read, and search across data structures in Redis.
-   * - `AsyncSearchIndex <#asyncsearchindex_api>`_
+   * - :ref:`asyncsearchindex_api`
      - Async version of the SearchIndex to write, read, and search across data structures in Redis.
 
+.. _searchindex_api:
+
 SearchIndex
 ===========
 
-.. _searchindex_api:
-
 .. currentmodule:: redisvl.index
 
 .. autoclass:: SearchIndex
    :inherited-members:
    :members:
 
+.. _asyncsearchindex_api:
+
 AsyncSearchIndex
 ================
 
-.. _asyncsearchindex_api:
-
 .. currentmodule:: redisvl.index
 
 .. autoclass:: AsyncSearchIndex

diff --git a/docs/conf.py b/docs/conf.py
@@ -79,8 +79,8 @@
 html_logo = "_static/Redis_Favicon_32x32_Red.png"
 html_favicon = "_static/Redis_Favicon_32x32_Red.png"
 html_context = {
-    "github_user": "Redis",
-    "github_repo": "Redis-VL-python",
+    "github_user": "redis",
+    "github_repo": "redis-vl-python",
     "github_version": "main",
     "doc_path": "docs",
 }