Create optional checkVersion function

Author: Alex Vorbau

versionwarning/_static/js/versionwarning.js

@@ -4,6 +4,9 @@ function injectVersionWarningBanner(running_version, version, config) {
     console.debug("injectVersionWarningBanner");
     var version_url = window.location.pathname.replace(running_version.slug, version.slug);
     var warning = $(config.banner.html);
+    if (config.meta.check_version_fn) {
+        version_url = config.meta.api_url;
+    }
 
     warning
       .find("a")
@@ -43,6 +46,15 @@ function getHighestVersion(versions) {
     return highest_version;
 }
 
+function showBanner(running_version, highest_version, config) {
+    console.debug("showBanner");
+    if (
+        semver.valid(semver.coerce(running_version.slug)) && semver.valid(semver.coerce(highest_version.slug)) &&
+        semver.lt(semver.coerce(running_version.slug), semver.coerce(highest_version.slug))) {
+        console.debug("Highest version: " + highest_version.slug);
+        injectVersionWarningBanner(running_version, highest_version, config);
+    }
+}
 
 function checkVersion(config) {
     console.debug("checkVersion");
@@ -67,12 +79,7 @@ function checkVersion(config) {
         success: function (versions) {
             // TODO: fetch more versions if there are more pages (next)
             highest_version = getHighestVersion(versions["results"]);
-            if (
-                semver.valid(semver.coerce(running_version.slug)) && semver.valid(semver.coerce(highest_version.slug)) &&
-                semver.lt(semver.coerce(running_version.slug), semver.coerce(highest_version.slug))) {
-                console.debug("Highest version: " + highest_version.slug);
-                injectVersionWarningBanner(running_version, highest_version, config);
-            }
+            showBanner(running_version, highest_version, config);
         },
         error: function () {
             console.error("Error loading Read the Docs active versions.");
@@ -97,6 +104,11 @@ function init() {
             else if (config.banner.custom) {
                 injectCustomWarningBanner(config);
             }
+            else if (config.meta.check_version_fn) {
+                // A custom function for checking version is defined globally
+                var fn = window[config.meta.check_version_fn];
+                fn(config, showBanner);
+            }
             else {
                 checkVersion(config);
             }

versionwarning/_static/js/versionwarning.src.js

@@ -28,6 +28,7 @@ def setup(app):
     app.add_config_value('versionwarning_body_selector', 'div.body', 'html')
     app.add_config_value('versionwarning_project_slug', os.environ.get('READTHEDOCS_PROJECT', None), 'html')
     app.add_config_value('versionwarning_project_version', os.environ.get('READTHEDOCS_VERSION', None), 'html')
+    app.add_config_value('versionwarning_check_version_fn', '', 'html')
 
     if sphinx.version_info >= (1, 8):
         # ``config-initied`` requires Sphinx >= 1.8

versionwarning/extension.py

@@ -46,6 +46,7 @@ def generate_versionwarning_data_json(app, config=None, **kwargs):
     data = json.dumps({
         'meta': {
             'api_url': config.versionwarning_api_url,
+            'check_version_fn': config.versionwarning_check_version_fn,
         },
         'banner': {
             'html': banner_html,