fix(docs): add sphinxcontrib-jquery to fix search on Sphinx 7+#171
Open
realsudarshan wants to merge 2 commits intoActivityWatch:masterfrom
Open
fix(docs): add sphinxcontrib-jquery to fix search on Sphinx 7+#171realsudarshan wants to merge 2 commits intoActivityWatch:masterfrom
realsudarshan wants to merge 2 commits intoActivityWatch:masterfrom
Conversation
Contributor
Greptile SummaryThis PR fixes the docs search bar hanging on "Searching…" by adding Confidence Score: 5/5Safe to merge — targeted, well-understood fix with no functional regressions. The change is minimal (one new dependency + one extension entry) and directly addresses a known compatibility gap between Sphinx 7 and sphinx_rtd_theme. No logic is altered, no security surface is affected, and the fix is consistent with the existing codebase style. No files require special attention. Important Files Changed
Sequence DiagramsequenceDiagram
participant Sphinx as Sphinx 7+
participant RTD as sphinx_rtd_theme
participant jQuery as sphinxcontrib.jquery
participant Browser as Browser (search)
Sphinx->>RTD: Build HTML
Sphinx->>jQuery: Load extension (injects jQuery)
jQuery-->>Sphinx: jQuery bundled into _static/
RTD-->>Browser: Render search page with jQuery available
Browser->>Browser: Search works correctly
Reviews (2): Last reviewed commit: "chore: update poetry.lock to match pypro..." | Re-trigger Greptile |
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
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.
What does this PR do?
Fixes the search bar being stuck on "Searching..." on docs.activitywatch.net
Root cause
Sphinx 6+ removed jQuery from its default bundle, but
sphinx_rtd_themedepends on it for search functionality. This caused search to silently
fail and hang indefinitely.
Fix
sphinxcontrib-jqueryto dependencies inpyproject.tomlsphinxcontrib.jqueryto the extensions list insrc/conf.pyTesting
Tested locally by serving the built docs with
python -m http.serverand confirmed search returns results correctly after the fix.
fixed.mp4
Fixes #170