-
Notifications
You must be signed in to change notification settings - Fork 1.1k
Add version warning banner for "latest" sphinx docs #1346
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
64bc094
add warning banner js
kandersolar def6e3b
Merge branch 'master' into latest_banner
kandersolar f215e79
modify for pydata sphinx theme
kandersolar d6f006a
another tweak
kandersolar 01bec0f
reproduce original license text
kandersolar File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| "use strict"; | ||
|
|
||
| // Source: | ||
| // https://github.com/anymail/django-anymail/blob/4c443f5515d1d5269a95cb54cf75057c56a3b150/docs/_static/version-alert.js | ||
| // via: | ||
| // https://github.com/qucontrol/krotov/blob/969fc980346e6411903de854118c48c51208a810/docs/_static/version-alert.js | ||
| // following instructions here: | ||
| // https://michaelgoerz.net/notes/showing-a-warning-for-the-latest-documentation-on-readthedocs.html | ||
|
|
||
| function warnOnLatestVersion() { | ||
|
|
||
| // The warning text and link is really specific to RTD hosting, | ||
| // so we can just check their global to determine version: | ||
| if (!window.READTHEDOCS_DATA || window.READTHEDOCS_DATA.version !== "latest") { | ||
| return; // not latest, or not on RTD | ||
| } | ||
|
|
||
| var warning = document.createElement('div'); | ||
| warning.setAttribute('class', 'admonition danger'); | ||
| warning.innerHTML = "<p class='first admonition-title'>Note</p> " + | ||
| "<p class='last'> " + | ||
| "This document is for an <strong>unreleased development version</strong>. " + | ||
| "Documentation is available for the <a href='/en/stable/'>current stable release</a>, " + | ||
| "or for older versions through the “v:” menu at bottom right." + | ||
| "</p>"; | ||
| warning.querySelector('a').href = window.location.pathname.replace('/latest', '/stable'); | ||
|
|
||
| // modified from original to work better w/ pydata sphinx theme | ||
| var parent = document.querySelector('main') || document.body; | ||
| parent.insertBefore(warning, parent.firstChild); | ||
| } | ||
|
|
||
| document.addEventListener('DOMContentLoaded', warnOnLatestVersion); | ||
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
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.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line is a bit heavy-handed in that it replaces any and all instances (not just the relevant instance) of
/latestwith/stablein the url. So if we someday have a page that happens to contain an unrelated "/latest" (e.g./en/latest/auto_examples/latest_CEC_modules.htmlor something), it would blindly edit both instances. I guess an easy improvement is to replace/en/latestwith/en/stable. I guess the most robust fix would include some semantic understanding of URL structure. Maybe this is much ado about something that will probably never happen.