Skip to content

Docs: document search_show_subprojects_filter addon option#12802

Draft
Copilot wants to merge 2 commits intomainfrom
copilot/document-disable-search-subprojects
Draft

Docs: document search_show_subprojects_filter addon option#12802
Copilot wants to merge 2 commits intomainfrom
copilot/document-disable-search-subprojects

Conversation

Copy link
Contributor

Copilot AI commented Feb 19, 2026

The search_show_subprojects_filter option (added in #12684) was never documented, leaving no public reference for how to disable the subprojects filter in the search modal.

Changes

  • docs/user/server-side-search/index.rst — Expanded the "Search across subprojects" feature entry to note that the search modal includes a subprojects filter and that it can be disabled via Settings > Addons > Search > Show subprojects filter in search modal.

  • docs/user/addons.rst — Added a "Disabling the subprojects filter in search" subsection under "Configuring Read the Docs Addons" explaining the option, its use case (e.g. avoiding cross-contamination between a project and its dev/staging subprojects), and where to find it in the UI.

Original prompt

This section details on the original issue you should resolve

<issue_title>Docs: document about disabling searching on subprojects</issue_title>
<issue_description>## What's the problem this feature will solve?

We have an option for this in the addons search_show_subprojects_filter, it was added in #12684, but isn't documented.
</issue_description>

<agent_instructions>Document this in server-side-search/index.rst, and maybe mention it in addons.rst.</agent_instructions>

Comments on the Issue (you are @copilot in this section)


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: stsewd <4975310+stsewd@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for disabling search on subprojects Docs: document search_show_subprojects_filter addon option Feb 19, 2026
Copilot AI requested a review from stsewd February 19, 2026 22:22
@read-the-docs-community
Copy link

Documentation build overview

📚 docs | 🛠️ Build #31480819 | 📁 Comparing 34784e5 against latest (4725bf8)


🔍 Preview build

Show files changed (2 files in total): 📝 2 modified | ➕ 0 added | ➖ 0 deleted
File Status
addons.html 📝 modified
server-side-search/index.html 📝 modified

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: document about disabling searching on subprojects

2 participants