Remove static banner generation

Author: humitos

README.rst

@@ -72,7 +72,7 @@ Customization
 
 Some customization can be done using the ``conf.py`` file of your Sphinx project:
 
-versionwarning_default_admonition_type (string)
+versionwarning_admonition_type (string)
    type of admonition for the banner (warning, admonition or note)
 
 versionwarning_default_message (string)
@@ -81,9 +81,6 @@ versionwarning_default_message (string)
 versionwarning_messages (dict)
    mapping between versions and messages for its banners
 
-versionwarning_message_placeholder (string)
-   text to be replaced by the version number link from the message
-
 versionwarning_project_slug (string)
    slug of the project under Read the Docs (default to ``READTHEDOCS_PROJECT`` environment variable)
 
@@ -102,9 +99,6 @@ versionwarning_banner_id_div (string)
 versionwarning_body_default_selector (string)
    jQuery selector to find the body element in the page
 
-versionwarning_body_extra_selector (string)
-   jQuery selector to find the body element in the page if ``versionwarning_body_default_selector`` wasn't found
-
 
 How to contribute?
 ------------------

versionwarning/__init__.py

@@ -1,56 +1,3 @@
 # -*- coding: utf-8 -*-
-
 name = 'versionwarning'
-version = '0.2.0'
-
-
-def setup(app):
-    import os
-    import sphinx
-    from .signals import process_version_warning_banner, generate_versionwarning_data_json
-
-    default_message = 'You are not reading the most up to date version of this documentation. {newest} is the newest version.'
-
-    banner_html = '''
-    <div id="{id_div}" class="admonition warning">
-        <p class="first admonition-title">{banner_title}</p>
-            <p class="last">
-                {message}
-            </p>
-    </div>'''.format(
-        id_div='version-warning-banner',
-        banner_title='Warning',
-        message=default_message.format(newest='<a href="#"></a>'),
-    )
-
-    app.add_config_value('versionwarning_message_placeholder', '{newest}', 'html')
-    app.add_config_value('versionwarning_default_admonition_type', 'warning', 'html')
-    app.add_config_value('versionwarning_default_message', default_message, 'html')
-    app.add_config_value('versionwarning_messages', {}, 'html')
-
-    app.add_config_value('versionwarning_api_url', 'https://readthedocs.org/api/v2/', 'html')
-    app.add_config_value('versionwarning_banner_html', banner_html, 'html')
-    app.add_config_value('versionwarning_banner_id_div', 'version-warning-banner', 'html')
-    app.add_config_value('versionwarning_body_default_selector', 'div.body', 'html')
-    app.add_config_value('versionwarning_body_extra_selector', 'div.document', '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.connect('doctree-resolved', process_version_warning_banner)
-
-    if sphinx.version_info >= (1, 8):
-        # ``config-initied`` requires Sphinx >= 1.8
-        app.connect('config-inited', generate_versionwarning_data_json)
-
-        # ``add_js_file`` requires Sphinx >= 1.8
-        app.add_js_file('js/versionwarning.js')
-    else:
-        app.connect('builder-inited', generate_versionwarning_data_json)
-        app.add_javascript('js/versionwarning.js')
-
-    return {
-        'version': version,
-        'env_version': 1,
-        'parallel_read_safe': True,
-        'parallel_write_safe': True,
-    }
+version = '1.0.0'

versionwarning/_static/js/versionwarning.js

@@ -10,9 +10,6 @@ function injectVersionWarningBanner(running_version, version, config) {
       .text(version.slug);
 
     var body = $(config.banner.body_default_selector);
-    if (!body.length) {
-        body = $(config.banner.body_extra_selector);
-    }
     body.prepend(warning);
 }
 

versionwarning/_static/js/versionwarning.src.js

@@ -0,0 +1,47 @@
+# -*- coding: utf-8 -*-
+import os
+import sphinx
+from versionwarning import version
+from .signals import generate_versionwarning_data_json
+
+
+def setup(app):
+    default_message = 'You are not reading the most up to date version of this documentation. {newest} is the newest version.'
+
+    banner_html = '''
+    <div id="{id_div}" class="admonition {admonition_type}">
+        <p class="first admonition-title">{banner_title}</p>
+            <p class="last">
+                {message}
+            </p>
+    </div>'''
+
+    app.add_config_value('versionwarning_message_placeholder', 'newest', 'html')
+    app.add_config_value('versionwarning_admonition_type', 'warning', 'html')
+    app.add_config_value('versionwarning_default_message', default_message, 'html')
+    app.add_config_value('versionwarning_messages', {}, 'html')
+
+    app.add_config_value('versionwarning_api_url', 'https://readthedocs.org/api/v2/', 'html')
+    app.add_config_value('versionwarning_banner_html', banner_html, 'html')
+    app.add_config_value('versionwarning_banner_id_div', 'version-warning-banner', 'html')
+    app.add_config_value('versionwarning_banner_title', 'Warning', 'html')
+    app.add_config_value('versionwarning_body_default_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')
+
+    if sphinx.version_info >= (1, 8):
+        # ``config-initied`` requires Sphinx >= 1.8
+        app.connect('config-inited', generate_versionwarning_data_json)
+
+        # ``add_js_file`` requires Sphinx >= 1.8
+        app.add_js_file('js/versionwarning.js')
+    else:
+        app.connect('builder-inited', generate_versionwarning_data_json)
+        app.add_javascript('js/versionwarning.js')
+
+    return {
+        'version': version,
+        'env_version': 1,
+        'parallel_read_safe': True,
+        'parallel_write_safe': True,
+    }

versionwarning/banner.py

@@ -1,26 +1,12 @@
 # -*- coding: utf-8 -*-
 
-from docutils import nodes
 import json
 import os
 
-from .banner import VersionWarningBanner
 
 STATIC_PATH = os.path.join(os.path.dirname(__file__), '_static')
 
 
-def process_version_warning_banner(app, doctree, fromdocname):
-    """
-    Insert an ``admonition`` with a custom/general message.
-    """
-
-    banner = VersionWarningBanner(app, doctree)
-    for document in doctree.traverse(nodes.document):
-        banner = banner.get_banner_node()
-        if isinstance(banner, nodes.Admonition):
-            document.insert(0, banner)
-
-
 def generate_versionwarning_data_json(app, **kwargs):
     """
     Generate the ``versionwarning-data.json`` file.
@@ -40,23 +26,31 @@ def generate_versionwarning_data_json(app, **kwargs):
     if config is None:
         config = app.config
 
+    banner_html = config.versionwarning_banner_html.format(
+        id_div=config.versionwarning_banner_id_div,
+        banner_title=config.versionwarning_banner_title,
+        message=config.versionwarning_default_message.format(
+            **{config.versionwarning_message_placeholder: '<a href="#"></a>'},
+        ),
+        admonition_type=config.versionwarning_admonition_type,
+    )
+
     data = json.dumps({
         'meta': {
             'api_url': config.versionwarning_api_url,
         },
         'banner': {
-            'html': config.versionwarning_banner_html,
+            'html': banner_html,
             'id_div': config.versionwarning_banner_id_div,
             'body_default_selector': config.versionwarning_body_default_selector,
-            'body_extra_selector': config.versionwarning_body_extra_selector,
         },
         'project': {
             'slug': config.versionwarning_project_slug,
         },
         'version': {
-            'slug': config.version,
+            'slug': config.versionwarning_project_version,
         },
-    })
+    }, indent=4)
 
     data_path = os.path.join(STATIC_PATH, 'data')
     if not os.path.exists(data_path):