Integrate version compare API info into footer_html endpoint #1499
Conversation
|
Big +1 on making our JS more managable. |
| } | ||
|
|
||
|
|
||
| function setupBookmarkCSRFToken() { |
There was a problem hiding this comment.
We can probably kill this for now -- we have killed the Bookmarking feature (it was half done, and probably not the most reasonable from a product perspective). However, this code does do some interesting things that we'll likely need to do when we actually look seriously at doing CNAME-supported javascript clients.
|
Looks like a solid refactor. 👍 -- Do we need to include any changes in the gulp configs or anything along those lines, or will it automagically just work? Edit: I see we're just making the existing |
Integrate version compare API info into footer_html endpoint
|
🎆 |
|
This broke when I tested it, so I've reverted it for now. It was depending on READTHEDOCS_DATA always being defined before the javascript was included, which is not the case in all themes. |
…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
…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
|
Sorry mate! 😿 I have addressed the raised issues in #1507 |
This integrates the data provided by
/api/v1/version/<project>/highest/<version>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.