Cleanup doc embed js #1507
Merged
Cleanup doc embed js #1507
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
| function injectFooter(data) { | ||
| // If the theme looks like ours, update the existing badge | ||
| // otherwise throw a a full one into the page. | ||
| if (build.is_rtd_theme()) { |
There was a problem hiding this comment.
build doesn't exist here.
There was a problem hiding this comment.
Argh :( that's addressed now.
ericholscher
added
the
PR: work in progress
…js"" This reverts commit 13a8162. Conflicts: readthedocs/core/static-src/core/js/readthedocs-doc-embed.js readthedocs/core/static/core/js/readthedocs-doc-embed.js
ericholscher
force-pushed
the
cleanup-doc-embed-js
branch
from
ca43574 to
a675748
Compare
Based on feedback: #1507 (comment)
There is no other place were the build instance was used and that is nicer than passing the object down the call chain. Based on feedback: #1507 (comment)
|
👍 |
|
Great. Tested this locally, and it appears to be working much better now :) |
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 is a re-PR of #1499 which was merged, then reverted.
Original PR text:
This integrates the data provided by /api/v1/version//highest/ into the /api/v2/footer_html/ response. We can use this to avoid one API request per doc page view. The API v1 version endpoint is still in place for backwards compatibility.
I also refactored the doc-embed JavaScript into multiple files for easier maintainability.
Fixes #1463.