Update sphinx_rtd_theme related JS in readthedocs-doc-embed.js #1631
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
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.
While investigating on #1622 I thought the reason for this might be that the vendored JS for the sphinx rtd theme was not up to date. Therefore I have updated it. That is the patch contained in this PR.
However it was clear while updating the JS that it's not a long-term solution to manually incorporate the JS of the theme. We should have a plan on a clearer integration of the theme JS into the
readthedocs-doc-embed.jscode.I would therefore suggest, that we make the JS in the rtd theme a CommonJS module that we can then
requireinreadthedocs-doc-embed.jsand therefore always serve the same code that the theme contains.