Skip to content

Commit 5cceaa4

Browse files
fix: remove the deleted link and add the version docs for pymeilisearch (#283)
Co-authored-by: Roberto Pastor Muela <[email protected]>
1 parent 8ef9ee0 commit 5cceaa4

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

doc/source/user_guide/options.rst

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,8 +130,7 @@ This dictionary should contain the following keys:
130130
corresponding user-friendly name. Each key-value pair in the dictionary
131131
represents an index, with the key being the index UID and the value
132132
being the index name. The index UID points to an index on the server.
133-
The list of all available indices can be found
134-
at `Active Public Indices <https://stunning-adventure-k6g9rqj.pages.github.io/active_indices.html>`_ .
133+
135134

136135
Here is an example configuration for using MeiliSearch in the ``conf.py`` file:
137136

@@ -148,6 +147,23 @@ Here is an example configuration for using MeiliSearch in the ``conf.py`` file:
148147
},
149148
}
150149
150+
If your project features multiple documentation versions, it's crucial to adapt the ``index_uids``
151+
mapping to accommodate different versions.
152+
To ensure seamless search integration across versions,
153+
use the following format to dynamically generate version-specific index ``UIDs``:
154+
155+
.. code-block:: python
156+
157+
from ansys_sphinx_theme import convert_version_to_pymeilisearch
158+
159+
use_meilisearch = {
160+
"api_key": os.getenv("MEILISEARCH_PUBLIC_API_KEY", ""),
161+
"index_uids": {
162+
f"ansys-sphinx-theme-v{convert_version_to_pymeilisearch(__version__)}": "ansys-sphinx-theme",
163+
},
164+
}
165+
166+
151167
Here is the example configuration of using MeiliSearch in
152168
``conf.py`` file of ``ansys-sphinx-theme``:
153169

0 commit comments

Comments
 (0)