Pin RTD search query to current version#328
Open
karlhillx wants to merge 1 commit into
Open
Conversation
The v3 search API call in getReadTheDocsResults was missing the version parameter, so RTD defaulted to the project's default version (stable). On non-stable builds (latest, a release branch, a PR build) search results linked to /en/stable/ pages instead of the version being read. Capture versions.current.slug from the readthedocs-addons-data-ready event and append &version=<slug> to the query. Fixes sunpy#327.
This was referenced Jun 8, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #327.
getReadTheDocsResultswas hitting/_/api/v3/search/without aversionparameter, so RTD fell back to the project's default version (usuallystable). On any non-stable build (latest, a release branch, a PR preview) the search box returned results linking to /en/stable/ instead of the version being read.This affects any project using the sunpy theme, including astropy (which inherits from it via the astropy-unified theme) — see astropy/astropy#19866, closed in favor of this fix.
The change captures
versions.current.slugfrom thereadthedocs-addons-data-readyevent and appends&version=<slug>to the search URL. The capture is wrapped in a try/catch so a missing event detail (e.g. local builds) leaves_rtdVersionnull and the existing behavior is preserved.