Skip to content

Docs: document search_show_subprojects_filter addon option #12802

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

Draft
Copilot wants to merge 2 commits into
base: main
Choose a base branch
from
+14 −0
Draft

Docs: document search_show_subprojects_filter addon option #12802

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
d8a2949
Initial plan
Copilot Feb 19, 2026
34784e5
Docs: document search_show_subprojects_filter addon option
Copilot Feb 19, 2026
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
11 changes: 11 additions & 0 deletions docs/user/addons.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,17 @@ Individual configuration options for each addon are available in :guilabel:`Sett
#. In the left bar, go to :guilabel:`Addons`.
#. Configure each Addon individually.

Disabling the subprojects filter in search
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

For projects that have :doc:`subprojects </subprojects>`,
the search modal shows a filter that lets users choose whether to include results from subprojects.
If your project does not need this filter (for example, if you want to keep search results focused on the main project),
you can disable it from :guilabel:`Settings` > :guilabel:`Addons` > :guilabel:`Search`
by unchecking :guilabel:`Show subprojects filter in search modal`.

See :doc:`/server-side-search/index` for more details.

Integrating with Addons
-----------------------

Expand Down
3 changes: 3 additions & 0 deletions docs/user/server-side-search/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@ Read the Docs has the following search features:
Search across :doc:`subprojects </subprojects>`
Subprojects allow you to host multiple discrete projects on a single domain.
Every subproject hosted on that same domain is included in the search results of the main project.
The search modal shows a filter that lets users choose whether to include subproject results.
If you don't need this filter, you can disable it from :guilabel:`Settings` > :guilabel:`Addons` > :guilabel:`Search`
by unchecking :guilabel:`Show subprojects filter in search modal`.

Search results land on the exact content you were looking for
We index every heading in the document,
Expand Down