Skip to content

docs: update the multi-index docs #708

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 27, 2025
Merged

docs: update the multi-index docs #708

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
846248c
docs: update the nmutkiindex doc
Revathyvenugopal162 May 27, 2025
0e86c8e
chore: adding changelog file 708.documentation.md [dependabot-skip]
pyansys-ci-bot May 27, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/changelog.d/708.documentation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
update the multi-index docs
13 changes: 6 additions & 7 deletions doc/source/user-guide/options.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,19 +197,18 @@
^^^^^^^^^^^^^^^^^^

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

**Example:**

.. code-block:: python

html_theme_options = {
"search_extra_sources": [
{"name": "PyMAPDL", "url": "https://mapdl.docs.pyansys.com/version/stable/"},
{"name": "PyAnsys", "url": "https://docs.pyansys.com/version/stable/"},
],
}
"search_extra_sources":
{
"PyMAPDL": "https://mapdl.docs.pyansys.com/version/stable/",
"PyAnsys": "https://docs.pyansys.com/version/stable/",
}

Search filters
^^^^^^^^^^^^^^
Expand Down Expand Up @@ -345,7 +344,7 @@

print("hello world")

If a format is used in the "content" field that does not fall into the categories above, it will not

Check warning on line 347 in doc/source/user-guide/options.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/user-guide/options.rst#L347 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user-guide/options.rst", "range": {"start": {"line": 347, "column": 93}}}, "severity": "WARNING"}
be rendered correctly.

To enable the "What's new" sections and sidebar in the changelog file, add the following dictionary
Expand All @@ -368,9 +367,9 @@
The dictionary contains the following keys:

- ``whatsnew_file_path``: The path to the YAML file containing what's new content local to the
``doc/source`` directory. If not provided, the what's new section will not be generated.

Check warning on line 370 in doc/source/user-guide/options.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/user-guide/options.rst#L370 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user-guide/options.rst", "range": {"start": {"line": 370, "column": 69}}}, "severity": "WARNING"}
- ``changelog_file_path``: The path to the changelog.rst file local to the ``doc/source``
directory. If not provided, the what's new section will not be generated.

Check warning on line 372 in doc/source/user-guide/options.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/user-guide/options.rst#L372 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user-guide/options.rst", "range": {"start": {"line": 372, "column": 54}}}, "severity": "WARNING"}
- ``sidebar_pages``: List of names for the pages to include the what's new sidebar on. If not
provided, the what's new sidebar is not displayed.
- ``sidebar_no_of_headers``: Number of minor version sections to display in the what's new sidebar.
Expand All @@ -395,5 +394,5 @@

.. note::

If you are using both the "whatsnew" and "cheatsheet" options, the "cheatsheet" option will be

Check warning on line 397 in doc/source/user-guide/options.rst

View workflow job for this annotation

GitHub Actions / vale

[vale] doc/source/user-guide/options.rst#L397 

[Google.Will] Avoid using 'will'.
Raw output 
{"message": "[Google.Will] Avoid using 'will'.", "location": {"path": "doc/source/user-guide/options.rst", "range": {"start": {"line": 397, "column": 92}}}, "severity": "WARNING"}
displayed first in the left navigation pane, followed by the "What's new" section to maintain
Expand Down
Loading