cmueller/ansible
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

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

Browse source 
* add banner to versions that are not latest

(cherry picked from commit 35b6345bdc)
This commit is contained in:
Sandra McCann 2019-07-05 10:35:39 -04:00 committed by Alicia Cozine
parent 8321cfb2a4
commit 3d9c2e8c23
3 changed files with 31 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
docs/docsite/_themes/sphinx_rtd_theme/ansible_banner.html Normal file
View file

@ -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
docs/docsite/_themes/sphinx_rtd_theme/layout.html
View file

@ -232,6 +232,8 @@
</div> --> </div> -->
{% include "breadcrumbs.html" %} {% include "breadcrumbs.html" %}
{% include "ansible_banner.html" %}
<div id="page-content"> <div id="page-content">
{% block body %}{% endblock %} {% block body %}{% endblock %}
</div> </div>

12
docs/docsite/rst/conf.py
View file

@ -144,7 +144,11 @@ html_context = {
'github_user': 'ansible', 'github_user': 'ansible',
'github_repo': 'ansible', 'github_repo': 'ansible',
'github_version': 'devel/docs/docsite/rst/', '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 # The style sheet to use for HTML and HTML Help pages. A file of that name
@ -263,9 +267,3 @@ autoclass_content = 'both'
intersphinx_mapping = {'python': ('https://docs.python.org/2/', (None, '../python2-2.7.13.inv')), 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')), 'python3': ('https://docs.python.org/3/', (None, '../python3-3.6.2.inv')),
'jinja2': ('http://jinja.pocoo.org/docs/', (None, '../jinja2-2.9.7.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')
}