Skip to content

Commit b954656

Browse files
authored
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
1 parent acf3c66 commit b954656

File tree

3 files changed

+20
-8
lines changed

3 files changed

+20
-8
lines changed

docs/api/reranker.rst

+12
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,15 @@ CohereReranker
1212
.. autoclass:: CohereReranker
1313
:show-inheritance:
1414
:members:
15+
16+
17+
HFCrossEncoderReranker
18+
========================
19+
20+
.. _hfcrossencoderreranker_api:
21+
22+
.. currentmodule:: redisvl.utils.rerank.hf_cross_encoder
23+
24+
.. autoclass:: HFCrossEncoderReranker
25+
:show-inheritance:
26+
:members:

docs/api/searchindex.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -8,27 +8,27 @@ Search Index Classes
88

99
* - Class
1010
- Description
11-
* - `SearchIndex <#searchindex_api>`_
11+
* - :ref:`searchindex_api`
1212
- Primary class to write, read, and search across data structures in Redis.
13-
* - `AsyncSearchIndex <#asyncsearchindex_api>`_
13+
* - :ref:`asyncsearchindex_api`
1414
- Async version of the SearchIndex to write, read, and search across data structures in Redis.
1515

16+
.. _searchindex_api:
17+
1618
SearchIndex
1719
===========
1820

19-
.. _searchindex_api:
20-
2121
.. currentmodule:: redisvl.index
2222

2323
.. autoclass:: SearchIndex
2424
:inherited-members:
2525
:members:
2626

27+
.. _asyncsearchindex_api:
28+
2729
AsyncSearchIndex
2830
================
2931

30-
.. _asyncsearchindex_api:
31-
3232
.. currentmodule:: redisvl.index
3333

3434
.. autoclass:: AsyncSearchIndex

docs/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,8 @@
7979
html_logo = "_static/Redis_Favicon_32x32_Red.png"
8080
html_favicon = "_static/Redis_Favicon_32x32_Red.png"
8181
html_context = {
82-
"github_user": "Redis",
83-
"github_repo": "Redis-VL-python",
82+
"github_user": "redis",
83+
"github_repo": "redis-vl-python",
8484
"github_version": "main",
8585
"doc_path": "docs",
8686
}

0 commit comments

Comments
 (0)