Project: show search settings in separate form by stsewd · Pull Request #12843 · readthedocs/readthedocs.org

stsewd · 2026-03-12T23:27:39Z

I didn't include the option to disable search indexing here since its from a separate model and it's only shown when we have disabled search indexing, but isn't that complex to integrate if we wanted 11f16a1.

Closes #11533

Requires readthedocs/ext-theme#709

stsewd · 2026-03-12T23:46:20Z

@copilot write a test for this view

Copilot · 2026-03-12T23:46:28Z

@stsewd I've opened a new pull request, #12844, to work on those changes. Once the pull request is ready, I'll request review from you.

…ew bugs (#12844) `ProjectSearchSettingsUpdate` had no tests and contained two bugs that were caught while writing them. ## Bugs fixed - **Missing `PrivateViewMixin`**: The view didn't inherit from `PrivateViewMixin`, so unauthenticated users were never redirected to login — they'd hit `get_object_or_404` directly and get a 404 instead of a redirect. - **`get_success_url()` crash on POST**: Used `self.object.slug`, but Django's `ModelFormMixin.form_valid()` reassigns `self.object = form.save()` — and since the form saves an `AddonsConfig` instance (not `Project`), this raised `AttributeError: 'AddonsConfig' object has no attribute 'slug'`. Fixed to use `self.get_project().slug`. ## Tests added `TestProjectSearchSettingsUpdate` in `readthedocs/projects/tests/test_views.py`: - `test_get_returns_200_for_admin` - `test_get_returns_404_for_non_admin` - `test_get_redirects_unauthenticated_user` - `test_post_updates_search_settings` — verifies `AddonsConfig.search_enabled` and `search_show_subprojects_filter` are persisted and redirects to the form URL - `test_post_updates_partial_search_settings` — verifies partial field updates work correctly ## Template Added a placeholder `projects/search_settings_form.html` following the same pattern as `pull_requests_form.html` (real implementation lives in ext-theme).  --- 📍 Connect Copilot coding agent with [Jira](https://gh.io/cca-jira-docs), [Azure Boards](https://gh.io/cca-azure-boards-docs) or [Linear](https://gh.io/cca-linear-docs) to delegate work to Copilot in one click without leaving your project management tool. --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: stsewd <4975310+stsewd@users.noreply.github.com>

Copilot

Pull request overview

This PR adds a dedicated “Search settings” page to the authenticated project admin area, separating search-modal configuration from the broader addons/project settings workflow.

Changes:

Added a new private dashboard update view + URL route for per-project search settings.
Introduced a focused ModelForm to edit only AddonsConfig search-related fields.
Added view tests covering access control and POST updates; updated search_enabled field verbose name (and migration).

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
`readthedocs/projects/views/private.py`	Adds `ProjectSearchSettingsUpdate` view to update project search settings.
`readthedocs/projects/urls/private.py`	Registers the new `/search-settings/` route in private project URLs.
`readthedocs/projects/tests/test_views.py`	Adds tests for GET/POST behavior and permissions for the new view.
`readthedocs/projects/forms.py`	Adds `AddonsConfigSearchSettingsForm` to edit only search-related `AddonsConfig` fields.
`readthedocs/projects/models.py`	Updates `AddonsConfig.search_enabled` verbose name (“Enable search modal”).
`readthedocs/projects/migrations/0159_update_addonsconfig_field_name.py`	Migration to apply the verbose name change to current + historical models.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

agjohnson

This looks okayish for now, however I noted how we had originally planned on pages like a top-level search page for all search configuration options, not just Addons search configuration options.

So while we could start with this, we're also just going to end up winding back this pattern to make a generic form that supports changing fields on Project and Addons next.

If it's easy enough to figure this pattern out now, we could do that here.

Otherwise, I don't see us wanting to break out just the Addons subpages to top level for any other subpage. A good example is all the pull request options, these would be best on a similar form mixing the existing pull request form and Addons diff options.

stsewd · 2026-04-09T14:44:29Z

If it's easy enough to figure this pattern out now, we could do that here.

I started this PR with support for multiple forms bfd6fce, but I reverted it back because we didn't really need the option from the project model yet.

agjohnson · 2026-04-09T15:33:40Z

Yup, it might be a minute before we want this either way. When we do we are going to want one single form on the view, I don't think we use multiple forms on a single page anywhere. So this will be a bit of a new pattern and the forms might be a little more disconnected from the modeling.

ericholscher · 2026-04-13T06:27:41Z

Would be good to merge this in, and update the docs to reference it. I'd also like to see a small header text on these pages, to make it a bit more usable for the user to understand what they can do here.

ericholscher · 2026-04-13T06:28:34Z

If it's easy enough to figure this pattern out now, we could do that here.

I started this PR with support for multiple forms bfd6fce, but I reverted it back because we didn't really need the option from the project model yet.

We should be able to just have a single form that saves multiple objects? I don't think we need multiple forms.

<img width="809" height="509" alt="image" src="https://github.com/user-attachments/assets/285e16c8-8613-47bd-ab20-34d91b01251e" /> ref readthedocs/readthedocs.org#12843

Co-authored-by: Anthony <aj@ohess.org>

read-the-docs-community · 2026-04-13T21:08:23Z

Documentation build overview

📚 dev | 🛠️ Build #32244288 | 📁 Comparing 93ef7ec against latest (5f1bdb6)

🔍 Preview build

No files changed.

stsewd · 2026-04-13T21:38:19Z

Hmm, looks like an old installation of ext-theme is cached by circleci, and they don't have an interface to purge a cache :/

stsewd · 2026-04-13T22:13:13Z

Tests are passing locally, merging. Will open another PR for the CI problem

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.

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>

stsewd added 3 commits March 12, 2026 18:26

Project: show search settings in separate form

bfd6fce

Don't include search indexing setting

11f16a1

Migration

10db30e

Copilot AI mentioned this pull request Mar 12, 2026

Project: show search settings in separate form — add tests and fix view bugs #12844

Merged

stsewd and others added 3 commits March 12, 2026 19:21

Fix test

eb3582e

Delete template

c715af3

stsewd marked this pull request as ready for review March 16, 2026 21:02

stsewd requested a review from a team as a code owner March 16, 2026 21:02

stsewd requested a review from humitos March 16, 2026 21:02

auto-assign bot assigned stsewd Mar 16, 2026

stsewd mentioned this pull request Mar 16, 2026

Project: show search settings in separate form readthedocs/ext-theme#709

Merged

stsewd requested a review from Copilot April 7, 2026 19:35

Copilot started reviewing on behalf of stsewd April 7, 2026 19:36 View session

Copilot AI reviewed Apr 7, 2026

View reviewed changes

Comment thread readthedocs/projects/tests/test_views.py Outdated

Comment thread readthedocs/projects/views/private.py

stsewd added 2 commits April 7, 2026 17:40

Merge branch 'main' into show-search-settings

8799cf2

Remove import

43f5376

stsewd added this to 📍Roadmap Apr 8, 2026

github-project-automation bot moved this to Planned in 📍Roadmap Apr 8, 2026

stsewd moved this from Planned to Needs review in 📍Roadmap Apr 8, 2026

agjohnson approved these changes Apr 8, 2026

View reviewed changes

Comment thread readthedocs/projects/forms.py

stsewd and others added 2 commits April 13, 2026 16:07

Update readthedocs/projects/forms.py

b153ea0

Co-authored-by: Anthony <aj@ohess.org>

Merge branch 'main' into show-search-settings

93ef7ec

stsewd merged commit 30c0503 into main Apr 13, 2026
7 of 8 checks passed

stsewd deleted the show-search-settings branch April 13, 2026 22:13

github-project-automation bot moved this from Needs review to Done in 📍Roadmap Apr 13, 2026

ericholscher mentioned this pull request Apr 14, 2026

Document search modal configuration and subproject filtering #12936

Merged

Uh oh!

Conversation

stsewd commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stsewd commented Mar 12, 2026

Uh oh!

Copilot AI commented Mar 12, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

agjohnson left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stsewd commented Apr 9, 2026

Uh oh!

agjohnson commented Apr 9, 2026

Uh oh!

ericholscher commented Apr 13, 2026

Uh oh!

ericholscher commented Apr 13, 2026

Uh oh!

read-the-docs-community bot commented Apr 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

stsewd commented Apr 13, 2026

Uh oh!

stsewd commented Apr 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

stsewd commented Mar 12, 2026 •

edited

Loading

read-the-docs-community bot commented Apr 13, 2026 •

edited

Loading