Skip to content

Commit 9364f8b

Browse files
committed
Docs: reference the new project Search settings page
Follow-up to #12843, which moved project search configuration out of the Addons settings form into its own dedicated settings page. Update the server-side search, subprojects, and addons docs to point users to the new "Search" page under project Settings.
1 parent 30c0503 commit 9364f8b

File tree

3 files changed

+12
-3
lines changed

3 files changed

+12
-3
lines changed

docs/user/addons.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@ Individual configuration options for each addon are available in :guilabel:`Sett
4343
#. Go to the new :term:`dashboard`.
4444
#. Click on a project name.
4545
#. Go to :guilabel:`Settings`.
46-
#. In the left bar, go to :guilabel:`Addons`.
47-
#. Configure each Addon individually.
46+
#. In the left bar, go to :guilabel:`Addons` to configure each Addon individually,
47+
or go to :guilabel:`Search` to configure the search addon options
48+
(which live on their own dedicated settings page).
4849

4950
Integrating with Addons
5051
-----------------------

docs/user/server-side-search/index.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,9 @@ Special query syntax for more specific results
4747
Configurable
4848
Tweak search results according to your needs using a
4949
:ref:`configuration file <config-file/v2:search>`.
50+
You can also enable or disable the search modal,
51+
and toggle the subprojects filter shown inside it,
52+
from your project's :guilabel:`Settings`, in the left bar, under :guilabel:`Search`.
5053

5154
Ready to use
5255
We override the default search engine of your Sphinx project with ours

docs/user/subprojects.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,15 @@ they are presented with a flyout menu matching the subproject's versions and :do
9494
Search
9595
------
9696

97-
Search on the parent project will include results from its subprojects.
97+
Search on the parent project will include results from its subprojects,
98+
and readers can filter results by subproject from the search modal.
9899
If you search on the ``v1`` version of the parent project,
99100
results from the ``v1`` version of its subprojects will be included,
100101
or from the default version for subprojects that don't have a ``v1`` version.
101102

102103
This is currently the only way to share search results between projects,
103104
we do not yet support sharing search results between sibling subprojects or arbitrary projects.
105+
106+
The subprojects filter in the search modal can be turned off from the parent project's
107+
:guilabel:`Settings`, in the left bar, under :guilabel:`Search`,
108+
by unchecking :guilabel:`Show subprojects filter in search modal`.

0 commit comments

Comments
 (0)