Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add a banner message to warn when not on latest documentation #58526

Merged
merged 5 commits into from
Jun 28, 2019
Merged

Add a banner message to warn when not on latest documentation #58526

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1a03da6
add banner to versions that are not latest
samccann Jun 25, 2019
eddaa6f
move div into script
samccann Jun 27, 2019
3a77870
fix div
samccann Jun 27, 2019
b0647f1
move comment
samccann Jun 28, 2019
620a994
fix shippable errors
samccann Jun 28, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
24 changes: 24 additions & 0 deletions docs/docsite/_themes/sphinx_rtd_theme/ansible_banner.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<!--- Based on sphinx versionwarning extension. Extension currently only works on READTHEDOCS -->
{# Creates a banner at the top of the page for any version not latest. #}
<script>
current_url = window.location.href;
if ((current_url.search("latest") > -1) || (current_url.search("/{{ latest_version }}/") > -1)) {
// no banner for latest release
} else if (current_url.search("devel") > -1) {
document.write('<div id="banner_id" class="admonition caution">');
para = document.createElement('p');
banner_text=document.createTextNode("You are reading the *devel* version of the Ansible documentation - this version is not guaranteed stable. Use the version selection to the left if you want the latest stable released version.");
para.appendChild(banner_text);
element = document.getElementById('banner_id');
element.appendChild(para);
document.write('</div>');
} else {
document.write('<div id="banner_id" class="admonition caution">');
para = document.createElement('p');
banner_text=document.createTextNode("You are reading an older version of the Ansible documentation. Use the version selection to the left if you want the latest stable released version.");
para.appendChild(banner_text);
element = document.getElementById('banner_id');
element.appendChild(para);
document.write('</div>');
}
</script>
2 changes: 2 additions & 0 deletions docs/docsite/_themes/sphinx_rtd_theme/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -232,6 +232,8 @@
</div> -->

{% include "breadcrumbs.html" %}

{% include "ansible_banner.html" %}
<div id="page-content">
{% block body %}{% endblock %}
</div>
Expand Down
12 changes: 5 additions & 7 deletions docs/docsite/rst/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,11 @@
'github_user': 'ansible',
'github_repo': 'ansible',
'github_version': 'devel/docs/docsite/rst/',
'github_module_version': 'devel/lib/ansible/modules/'
'github_module_version': 'devel/lib/ansible/modules/',
'current_version': version,
'latest_version': '2.8',
# list specifically out of order to make latest work
'available_versions': ('latest', '2.7', '2.6', 'devel')
}

# The style sheet to use for HTML and HTML Help pages. A file of that name
Expand Down Expand Up @@ -263,9 +267,3 @@
intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2-2.7.13.inv')),
'python3': ('https://docs.python.org/3/', (None, '../python3-3.6.2.inv')),
'jinja2': ('http://jinja.pocoo.org/docs/', (None, '../jinja2-2.9.7.inv'))}

# list specifically out of order to make latest work
html_context = {
'current_version': version,
'available_versions': ('latest', '2.7', '2.6', 'devel')
}