Add search-as-you-type (inline search results) feature #2093
Conversation
|
This is super cool |
|
For me it's the most wanted feature, brilliant ! |
| // Don't interfere with the default search UX on /search.html. | ||
| if (window.location.pathname.endsWith("/search.html")) { | ||
| return; | ||
| } |
There was a problem hiding this comment.
we should also account for dirhtml builds, which I think (?) will have a url like https://whatever.com/en/search/ or potentially https://whatever.com/en/search/index.html
There was a problem hiding this comment.
dirhtml was not on my radar. Will need to look into what that does to figure out how it affects the impl.
There was a problem hiding this comment.
I introduced a temporary change to tox.ini in this PR to make docs-dev build dirhtml instead of html. It all seems to work fine still
| // searchtools.js loads. | ||
| // | ||
| // Search class is defined in upstream Sphinx: | ||
| // https://github.com/sphinx-doc/sphinx/blob/master/sphinx/themes/basic/static/searchtools.js#L181 |
There was a problem hiding this comment.
link to .../blob/master/... may suffer from line number drift or otherwise go stale. Let's use a permalink to a specific repo state.
There was a problem hiding this comment.
Fixed now, will let you resolve
| } | ||
|
|
||
| // Create a new search-as-you-type results container. | ||
| results = document.createElement("section"); |
There was a problem hiding this comment.
@gabalafou would appreciate your perspective on what is the best node type for an appearing/disappearing list of search results, and how this can/should/will interact with things like tab focus.
Coverage report
Click to see where and how coverage changed
This report was generated by python-coverage-comment-action |
||||||||||||||||||||||||
| @@ -122,7 +122,7 @@ set_env = PYDEVD_DISABLE_FILE_VALIDATION=1 | |||
| extras = {[testenv:docs-no-checks]extras} | |||
| package = editable | |||
| commands = | |||
| sphinx-build -b html docs/ docs/_build/html -v -w warnings.txt {posargs} | |||
| sphinx-build -b dirhtml docs/ docs/_build/html -v -w warnings.txt {posargs} | |||
There was a problem hiding this comment.
This should be reverted before (hopefully eventually) merging
|
@drammock all actionable feedback addressed |
time for more feedback then 😆 I was just playing around with the CI build, and 2 things didn't match expectations:
|
Fixes #1977