mirror of
https://github.com/pacnpal/django-anymail.git
synced 2025-12-20 03:41:05 -05:00
* Update docs build config
* Specify Sphinx and theme versions in docs/requirements.txt
(tox had been using latest; RTD had pinned older versions)
* Update docs builds for Python 3 and recent Sphinx
* Remove obsolete sphinx-rtd-theme patches
* Add .readthedocs.yml
* Move some JS to async (now that Sphinx supports that)
* Fix version-alert.js for async loading
* Remove docs versionadded/changed info older than v3.0
* Fix broken GitHub issue links in changelog (never worked?)
* Add setup long_description_content_type
* Drop poorly maintained AUTHORS.txt
(just point to GitHub contributors page)
35 lines
1.4 KiB
JavaScript
35 lines
1.4 KiB
JavaScript
"use strict";
|
|
|
|
// Similar to https://github.com/readthedocs/readthedocs.org/blob/5.2.3/readthedocs/core/static-src/core/js/doc-embed/version-compare.js
|
|
// but adds admonition for the "latest" version -- which is (unreleased) main branch.
|
|
|
|
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 left." +
|
|
"</p>";
|
|
warning.querySelector('a').href = window.location.pathname.replace('/latest', '/stable');
|
|
|
|
var parent = document.querySelector('div.body')
|
|
|| document.querySelector('div.document')
|
|
|| document.body;
|
|
parent.insertBefore(warning, parent.firstChild);
|
|
}
|
|
|
|
if (document.readyState === 'loading') {
|
|
document.addEventListener('DOMContentLoaded', warnOnLatestVersion);
|
|
} else {
|
|
warnOnLatestVersion();
|
|
}
|