Skip to content

Commit 5ca109e

Browse files
ericholscherclaude
andauthored
Document search modal configuration and subproject filtering (#12936)
Follow-up to #12843, which moved project search configuration into its own dedicated settings page. Updates the existing "Configurable" bullet in the server-side search docs and the "Search" section in the subprojects docs to point readers at `Settings > Search`. Closes #11533. 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude <noreply@anthropic.com>
1 parent 981a700 commit 5ca109e

File tree

2 files changed

+24
-1
lines changed

2 files changed

+24
-1
lines changed

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

Lines changed: 18 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
@@ -82,6 +85,21 @@ It also saves recent searches, for future reference.
8285

8386
Try it by pressing :guilabel:`/` (forward slash) and typing.
8487

88+
Configuring search
89+
------------------
90+
91+
You can configure search options for your project from the :term:`dashboard`:
92+
93+
#. Go to the :term:`dashboard`.
94+
#. Click on a project name.
95+
#. Go to :guilabel:`Settings`.
96+
#. In the left bar, go to :guilabel:`Search`.
97+
98+
From there you can toggle :guilabel:`Enable search modal`,
99+
which controls whether the Read the Docs search modal is shown in your documentation,
100+
and :guilabel:`Show subprojects filter in search modal`,
101+
which controls whether readers can filter search results by :doc:`subproject </subprojects>`.
102+
85103
How main content is detected
86104
----------------------------
87105

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 disabling :guilabel:`Show subprojects filter in search modal`.

0 commit comments

Comments
 (0)