Skip to content

Commit 0ba5fe9

Browse files
committed
Rename versionwarning_body_default_selector by versionwarning_body_selector
1 parent fb4afea commit 0ba5fe9

4 files changed

Lines changed: 6 additions & 6 deletions

File tree

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,8 @@ versionwarning_banner_html (string)
9696
versionwarning_banner_id_div (string)
9797
HTML element ID used for the <div> inject as banner
9898

99-
versionwarning_body_default_selector (string)
100-
jQuery selector to find the body element in the page
99+
versionwarning_body_selector (string)
100+
jQuery selector to find the body element in the page and *prepend* the banner
101101

102102

103103
How to contribute?

versionwarning/_static/js/versionwarning.src.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,15 @@ function injectVersionWarningBanner(running_version, version, config) {
1010
.attr("href", version_url)
1111
.text(version.slug);
1212

13-
var body = $(config.banner.body_default_selector);
13+
var body = $(config.banner.body_selector);
1414
body.prepend(warning);
1515
}
1616

1717

1818
function injectCustomWarningBanner(config) {
1919
console.debug("injectCustomWarningBanner");
2020
var warning = $(config.banner.html);
21-
var body = $(config.banner.body_default_selector);
21+
var body = $(config.banner.body_selector);
2222
body.prepend(warning);
2323
}
2424

versionwarning/extension.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def setup(app):
2525
app.add_config_value('versionwarning_banner_html', banner_html, 'html')
2626
app.add_config_value('versionwarning_banner_id_div', 'version-warning-banner', 'html')
2727
app.add_config_value('versionwarning_banner_title', 'Warning', 'html')
28-
app.add_config_value('versionwarning_body_default_selector', 'div.body', 'html')
28+
app.add_config_value('versionwarning_body_selector', 'div.body', 'html')
2929
app.add_config_value('versionwarning_project_slug', os.environ.get('READTHEDOCS_PROJECT', None), 'html')
3030
app.add_config_value('versionwarning_project_version', os.environ.get('READTHEDOCS_VERSION', None), 'html')
3131

versionwarning/signals.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ def generate_versionwarning_data_json(app, **kwargs):
4949
'banner': {
5050
'html': banner_html,
5151
'id_div': config.versionwarning_banner_id_div,
52-
'body_default_selector': config.versionwarning_body_default_selector,
52+
'body_selector': config.versionwarning_body_selector,
5353
'custom': custom,
5454
},
5555
'project': {

0 commit comments

Comments
 (0)