Skip to content

Conversation

@mosc9575
Copy link
Contributor

@mosc9575 mosc9575 commented Apr 12, 2024

This PR will fix the broken search on the start page of the documentation. The search was broken, because the search-button is searching for a valid from inside a <div></div>. This was missing and because of this, the button raised an error.

See the gif below to see how this works on the latest published page.


broken-search


I also want to quote from https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/search.html:

If a page includes both the search button and an always-visible search field, the keyboard shortcuts will focus on the always-visible field and the hidden search field overlay will not display. This may not be what you want: on small screens (i.e. mobile devices) the sidebars may be hidden in a drawer, and if the persistent search field is there, it may receive focus without actually being made visible. It is strongly recommended that you use either the search button and the hidden/overlaid field that comes with it, or use a persistent search field in a place that makes sense for your layout.

This is the case on the docs of bokeh. For smaller screens the search button will go to the side bar without any visiable change for the user.

This PR does not solve the JS error with the version banner. The banner is broken for

@mosc9575 mosc9575 added this to the 3.5 milestone Apr 12, 2024
@codecov
Copy link

codecov bot commented Apr 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 92.62%. Comparing base (e61219b) to head (477d447).
Report is 6 commits behind head on branch-3.5.

Additional details and impacted files
@@              Coverage Diff               @@
##           branch-3.5   #13823      +/-   ##
==============================================
+ Coverage       91.57%   92.62%   +1.04%     
==============================================
  Files             326      326              
  Lines           20737    20762      +25     
==============================================
+ Hits            18990    19230     +240     
+ Misses           1747     1532     -215     

@bryevdv
Copy link
Member

bryevdv commented Apr 12, 2024

This PR does not solve the JS error with the version banner. The banner is broken for

Ideally we can migrate to the theme banner and ditch our custom solution entirely, but that will take some testing and I think we will have to add a new "switcher v2" file since I think the format for the switcher config has changed

@mosc9575 mosc9575 merged commit bb0f4b6 into bokeh:branch-3.5 Apr 12, 2024
@mosc9575 mosc9575 deleted the 13789_search_on_start_page branch April 12, 2024 16:59
@mosc9575 mosc9575 mentioned this pull request Jun 12, 2024
11 tasks
mattpap pushed a commit that referenced this pull request Jun 12, 2024
@mattpap mattpap modified the milestones: 3.5, 3.4.2 Jun 12, 2024
Chiemezuo pushed a commit to Chiemezuo/bokeh that referenced this pull request Aug 27, 2024
@github-actions
Copy link

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Oct 25, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG] JS errors on Bokeh docs page

3 participants