Fix search.html with newer sphinx versions #34
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
This commit fixes an issue with search.html when building with newer versions of sphinx. Since the release of sphinx 3.4.0 the search bar has not worked when using the qiskit_sphinx_theme package. This is because we were not loading a required script to make the search bar work with the new sphinx theme. This was done in the upstream pytorch_sphinx_theme package with: pytorch/pytorch_sphinx_theme@d033830 which looks like it was itself ported from the sphinx-rtd-theme package which fixed this same issue with: readthedocs/sphinx_rtd_theme#1021 This is just porting that change to qiskit_sphinx_theme which at least fixes the search bar in local builds for me.
nonhermitian
approved these changes
Jun 1, 2021
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.
This commit fixes an issue with search.html when building with newer
versions of sphinx. Since the release of sphinx 3.4.0 the search bar
has not worked when using the qiskit_sphinx_theme package. This is
because we were not loading a required script to make the search bar
work with the new sphinx theme. This was done in the upstream
pytorch_sphinx_theme package with:
pytorch/pytorch_sphinx_theme@d033830
which looks like it was itself ported from the sphinx-rtd-theme package
which fixed this same issue with:
readthedocs/sphinx_rtd_theme#1021
This is just porting that change to qiskit_sphinx_theme which at least
fixes the search bar in local builds for me.