Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork66
Enable search shortcuts#135
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Enable already-existing JavaScript flag.Included since Sphinx 4.5.0https://www.sphinx-doc.org/en/master/changes.html#release-4-5-0-released-mar-28-2022
ghost commentedJul 25, 2023 • edited by ghost
Loading Uh oh!
There was an error while loading.Please reload this page.
edited by ghost
Uh oh!
There was an error while loading.Please reload this page.
Sadly, this doesn't work 100% because we create multiple searchbox elements per page with our own layout.
(there's one more, I haven't hunted it down yet) I'm guessing this would be a little more involved in restructuring the layout template to reduce the duplication, and thus enable taking advantage of their already-supplied functionality. If there's appetite for that, I'll pursue it. |
Nice, I didn't know this was a Sphinx option, I'd prefer to use this than the custom JavaScript in#131. (Although there's not much JS in there.) https://www.sphinx-doc.org/en/master/usage/theming.html says:
Does it really default to We don't have |
Turns out, it does default to True, so this PR is also unnecessary! Pressing the slash key today does in fact work, however it places the focus on the hidden mobile nav search box since it appears first in the HTML. 🤔 I wonder if we still need an explicit mobile nav, or if the signature could be changed so it still works correctly but does not appear first in the selector. |
Even simpler!#141 |
Uh oh!
There was an error while loading.Please reload this page.
Enable already-existing JavaScript flag.
Included since Sphinx 4.5.0https://www.sphinx-doc.org/en/master/changes.html#release-4-5-0-released-mar-28-2022
Thedoctools.js file that is served today includes the functionality - look for
DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
Ithink that the only piece needed is setting the config option
enable_search_shortcuts = True
inhttps://github.com/python/python-docs-theme/blob/4dbc102a556c520b10fc387821967e54dee77654/python_docs_theme/theme.confWe inherit from
default
theme, whichinheritsclassic
, which inheritsbasic
theme.Alternative to#131