File tree Expand file tree Collapse file tree 1 file changed +18
-2
lines changed Expand file tree Collapse file tree 1 file changed +18
-2
lines changed Original file line number Diff line number Diff line change @@ -130,8 +130,7 @@ This dictionary should contain the following keys:
130
130
corresponding user-friendly name. Each key-value pair in the dictionary
131
131
represents an index, with the key being the index UID and the value
132
132
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
+
135
134
136
135
Here is an example configuration for using MeiliSearch in the ``conf.py `` file:
137
136
@@ -148,6 +147,23 @@ Here is an example configuration for using MeiliSearch in the ``conf.py`` file:
148
147
},
149
148
}
150
149
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
+
151
167
Here is the example configuration of using MeiliSearch in
152
168
``conf.py `` file of ``ansys-sphinx-theme ``:
153
169
You can’t perform that action at this time.
0 commit comments