-
-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Override Sphinx integrated search with our indexes #1808
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 our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Conversation
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
5 tasks
6b5ae4f
to
50e1470
Compare
This is now unblocked. I created a |
agjohnson
added a commit
to readthedocs/readthedocs-sphinx-ext
that referenced
this pull request
Feb 27, 2016
agjohnson
added a commit
to readthedocs/readthedocs-sphinx-ext
that referenced
this pull request
Feb 28, 2016
agjohnson
added a commit
that referenced
this pull request
Feb 28, 2016
Override Sphinx integrated search with our indexes
mikethebeer
pushed a commit
to crate/crate-docs-theme
that referenced
this pull request
Mar 16, 2016
mikethebeer
pushed a commit
to crate/crate-docs-theme
that referenced
this pull request
Mar 16, 2016
mikethebeer
pushed a commit
to crate/crate-docs-theme
that referenced
this pull request
Mar 16, 2016
humitos
added a commit
that referenced
this pull request
Sep 30, 2024
humitos
added a commit
that referenced
this pull request
Oct 3, 2024
humitos
added a commit
that referenced
this pull request
Oct 7, 2024
* Domains: put a limit of 2 custom domains per project Related #1808 * Domains: add tests for limit amount of domains * Add missing import * Test: define 2 domains as limit for all the tests
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.
The Sphinx search "works", but our search returns more relevant results. This work will include an integrated front end interface for search results on generated documentation which pulls from our existing indexes.
Implementing this feature might be difficult on a wider basis, as themes all load their local
_static/searchtools.js
. The easiest place to start would be by reimplementingsearchtools.js
with a similar interface, or extending the existing implementation, and overriding this in our local template overrides path. This would only affect projects using our theme, or derivatives of, for now.The current
searchtools.js
implementation uses it's own search index data and performs its own text normalization and result scoring. An overridden implementation would rely on an elastic search backend, with supplemental information from the existing implementation. The current index has information on domain objects, which aren't surfaced in the same way in the search index. Results could be merged into the same search results tree, for display output. Features like highlighting in search results and the current search UI elements will be maintained.search.lib
This relies on readthedocs/readthedocs-sphinx-ext#16