Fix search on readthedocs.org #6821
Merged
Conversation
This file contains 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
1.2.2 includes PR 1448 which fixes issue 1452 - readthedocs/sphinx_rtd_theme#1448 - readthedocs/sphinx_rtd_theme#1452
andreasabel
changed the title
andreasabel
added
the
user-manual
JobPetrovcic
pushed a commit
to JobPetrovcic/agda
that referenced
this pull request
Apr 12, 2024
This addresses a regression in `sphinx_rtd_theme` that causes `sphinxcontrib.jquery` to be not loaded. Consequently, the search page seems to be hanging; the cause is that `jQuery` is undefined. Adding `sphinxcontrib.jquery` is a suggested workaround at readthedocs/sphinx_rtd_theme#1452. Since I see another problem with search locally and in the PR build on rtd.org, I bump to the latest `Sphinx` and `sphinx_rtd_theme`. This doesn't fix the problem, though. However, rtd.org seems to be fine with these requirements. The problem I have been seeing is a `undefined` sprinkled in the `requestUrl` variable in Sphinx's `searchtools.js` which causes page loads to fail for previewing the search hits. Maybe this problem will disappear in the regular build on rtd.org. Squashed commits: * Fix search on readthedocs.org by bumping sphinx_rtd_theme to 1.2.2 1.2.2 includes PR 1448 which fixes issue 1452 - readthedocs/sphinx_rtd_theme#1448 - readthedocs/sphinx_rtd_theme#1452 * Fixup: remove `html_theme_path` Suggested in readthedocs/sphinx_rtd_theme#1452 (comment) * Fixup 2: or, add 'sphinxcontrib.jquery' to 'extensions' * Fixup 3: bump to latest Sphinx and rtd theme
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Searching the docs of Agda 2.6.4 RC1 seems to hang, see e.g. https://agda.readthedocs.io/en/v2.6.3.20230805/search.html?q=instance&check_keywords=yes&area=default#
Fix search on readthedocs.org by bumping sphinx_rtd_theme to 1.2.2.
1.2.2 includes readthedocs/sphinx_rtd_theme#1448 which fixes the issue, readthedocs/sphinx_rtd_theme#1452.
Test this on: https://agda--6821.org.readthedocs.build/en/6821/search.html?q=instance&check_keywords=yes&area=default