Skip to content

Commit 81e13f8

Browse files
docs: update the multi-index docs (#708)
Co-authored-by: pyansys-ci-bot <[email protected]>
1 parent 5d3507b commit 81e13f8

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

doc/changelog.d/708.documentation.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
update the multi-index docs

doc/source/user-guide/options.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -197,19 +197,18 @@ Multi-index search
197197
^^^^^^^^^^^^^^^^^^
198198

199199
To enable search across multiple documentation sources, use the ``search_extra_sources`` key.
200-
This key should be assigned a list of dictionaries, where each dictionary represents an external index.
201-
Each entry must contain a display name and the URL of the documentation to be included.
200+
This key should be a dictionary where each key is the name of the source and the value is the URL to that source.
202201

203202
**Example:**
204203

205204
.. code-block:: python
206205
207206
html_theme_options = {
208-
"search_extra_sources": [
209-
{"name": "PyMAPDL", "url": "https://mapdl.docs.pyansys.com/version/stable/"},
210-
{"name": "PyAnsys", "url": "https://docs.pyansys.com/version/stable/"},
211-
],
212-
}
207+
"search_extra_sources":
208+
{
209+
"PyMAPDL": "https://mapdl.docs.pyansys.com/version/stable/",
210+
"PyAnsys": "https://docs.pyansys.com/version/stable/",
211+
}
213212
214213
Search filters
215214
^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)