feat: switch to readthedocs search addon #398
Merged
Conversation
This file contains 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
|
Waiting for the dashboard to be accessible for this project before merging in case addon settings need to be modified. |
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 search extension is no longer supported and readthedocs has moved to providing search via an addon. This PR switches to using that addon (must be enabled in the Addons settings of the ReadTheDocs admin dashboard).
This is still a custom integration that requires some extra JS to make work. Eventually the theme may directly support the integration (see pydata/pydata-sphinx-theme#1977), but for now this is what we have.
Note: some CSS updates for dark mode need to be made to improve the UX.
Based on dashpay/docs-core#122
Preview: https://dash-docs--398.org.readthedocs.build/en/398/