docs: add workaround for theme issues (search not working) - #7385
Merged
Conversation
This is a recommended workaround for search function & flyout menu not working with a combination of sphinx-6.2.1 & sphinx-rtd-theme-1.2.0. There is no additional dependency to install, since the theme already installs it. It is likely to be fixed with sphinx-rtd-theme v1.3, at which point the commit can be reverted. See: readthedocs/sphinx_rtd_theme#1452
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## maint #7385 +/- ##
===========================================
- Coverage 88.72% 33.53% -55.20%
===========================================
Files 327 327
Lines 44686 44157 -529
Branches 5922 5922
===========================================
- Hits 39647 14807 -24840
- Misses 5024 29162 +24138
- Partials 15 188 +173 ☔ View full report in Codecov by Sentry. |
mslw
added
the
semver-documentation
mslw
marked this pull request as ready for review
May 12, 2023 09:36
Collaborator
|
PR released in |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This is a recommended workaround for search function & flyout menu not working on Read the Docs with a combination of sphinx-6.2.1 & sphinx-rtd-theme-1.2.0. It is likely to be fixed with sphinx-rtd-theme v1.3, at which point the change can be reverted (or we can try to wait it out).
There is no additional dependency to install, since the theme already installs
sphinxcontrib.jquery.Fixes #7374