Skip to content

Conversation

@TTsangSC
Copy link
Collaborator

@TTsangSC TTsangSC commented Aug 14, 2025

Closes #292.

This PR implements the proposed fixes in the issue, attempting to fix the search function in the docs based on readthedocs/sphinx_rtd_theme#1448 and the associated thread:

  • docs/source/cont.py:
    sphinxcontrib.jquery is added as a Sphinx extension so there is a search to fall back on; this also allows for searches to work on local doc builds.
  • requirements/docs.txt:
    Bumped sphinx_rtd_theme to a version (1.2.1) containing the linked PR fixing the issue.
  • .readthedocs.yml:
    Bumped the build environment (Docker image and Python version) to something reasonably new but not bleeding-edge.

@TTsangSC TTsangSC added the documentation Improvements or additions to documentation label Aug 14, 2025
@Theelx
Copy link
Collaborator

Theelx commented Aug 14, 2025

Along with this PR, since it's a documentation issue: can you move the CHANGELOG.rst entry for #380 from the section under 5.0.0 to 5.0.1? #380 wasn't part of 5.0.0 at its release, and we can't modify existing releases. It'd be useful if you insert it in between the existing ENH and FIX boundary, because keeping the enhancements grouped together and fixes grouped together makes it easier for people to read the CHANGELOG.

@TTsangSC
Copy link
Collaborator Author

Ah yep I messed up, I thought I placed that under 5.0.1 already. Thanks for the heads up!

@codecov
Copy link

codecov bot commented Aug 14, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 88.13%. Comparing base (60e928f) to head (60aa93b).
⚠️ Report is 13 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #384      +/-   ##
==========================================
+ Coverage   87.56%   88.13%   +0.56%     
==========================================
  Files          18       20       +2     
  Lines        1641     1921     +280     
  Branches      348      412      +64     
==========================================
+ Hits         1437     1693     +256     
- Misses        149      168      +19     
- Partials       55       60       +5     

see 1 file with indirect coverage changes


Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1ea4a96...60aa93b. Read the comment docs.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Erotemic
Copy link
Member

Excellent, adding this into xcookie will fix search in all my respos. Thanks!

@Erotemic Erotemic merged commit b3ce880 into pyutils:main Aug 14, 2025
39 checks passed
@TTsangSC TTsangSC deleted the fix-doc-search branch August 14, 2025 23:25
@Erotemic
Copy link
Member

The RTD are so much nicer now: https://kernprof.readthedocs.io/en/latest/index.html

Somehow that also gave us a usable sidebar.

@TTsangSC
Copy link
Collaborator Author

Just noticed (since we're working on IPython stuff in #383) that the doc page for line_profiler.ipython_extension is not currently built; we probably need to update .readthedocs.yml so that IPython is installed when RTD builds the docs. Will write a PR for that.

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Search does not work in docs

3 participants