summaryrefslogtreecommitdiffstats
path: root/Doc
diff options
context:
space:
mode:
authorEzio Melotti <ezio.melotti@gmail.com>2012-10-27 19:09:16 (GMT)
committerEzio Melotti <ezio.melotti@gmail.com>2012-10-27 19:09:16 (GMT)
commit380ce651e940c977058cace141c6ed8a45b7d82a (patch)
tree04b16e259ed1b78ab0a92ea200f61c9534bc6cbd /Doc
parent252cd0e4e0b11c7d13e24146617ad48e80feca43 (diff)
downloadcpython-380ce651e940c977058cace141c6ed8a45b7d82a.zip
cpython-380ce651e940c977058cace141c6ed8a45b7d82a.tar.gz
cpython-380ce651e940c977058cace141c6ed8a45b7d82a.tar.bz2
#8040: add a version switcher to the documentation. Patch by Yury Selivanov.
Diffstat (limited to 'Doc')
-rw-r--r--Doc/tools/sphinxext/layout.html12
-rw-r--r--Doc/tools/sphinxext/static/version_switch.js60
2 files changed, 70 insertions, 2 deletions
diff --git a/Doc/tools/sphinxext/layout.html b/Doc/tools/sphinxext/layout.html
index db4a386..4b16b3f 100644
--- a/Doc/tools/sphinxext/layout.html
+++ b/Doc/tools/sphinxext/layout.html
@@ -3,18 +3,26 @@
<li><img src="{{ pathto('_static/py.png', 1) }}" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
<li><a href="http://www.python.org/">Python</a>{{ reldelim1 }}</li>
- <li><a href="{{ pathto('index') }}">{{ shorttitle }}</a>{{ reldelim1 }}</li>
+ <li>
+ {%- if versionswitcher is defined %}
+ <span class="version_switcher_placeholder">{{ release }}</span>
+ <a href="{{ pathto('index') }}">Documentation</a>{{ reldelim1 }}
+ {%- else %}
+ <a href="{{ pathto('index') }}">{{ shorttitle }}</a>{{ reldelim1 }}
+ {%- endif %}
+ </li>
{% endblock %}
{% block extrahead %}
<link rel="shortcut icon" type="image/png" href="{{ pathto('_static/py.png', 1) }}" />
{% if not embedded %}<script type="text/javascript" src="{{ pathto('_static/copybutton.js', 1) }}"></script>{% endif %}
+ {% if versionswitcher is defined and not embedded %}<script type="text/javascript" src="{{ pathto('_static/version_switch.js', 1) }}"></script>{% endif %}
{{ super() }}
{% endblock %}
{% block footer %}
<div class="footer">
&copy; <a href="{{ pathto('copyright') }}">Copyright</a> {{ copyright|e }}.
<br />
- The Python Software Foundation is a non-profit corporation.
+ The Python Software Foundation is a non-profit corporation.
<a href="http://www.python.org/psf/donations/">Please donate.</a>
<br />
Last updated on {{ last_updated|e }}.
diff --git a/Doc/tools/sphinxext/static/version_switch.js b/Doc/tools/sphinxext/static/version_switch.js
new file mode 100644
index 0000000..cc99153
--- /dev/null
+++ b/Doc/tools/sphinxext/static/version_switch.js
@@ -0,0 +1,60 @@
+(function() {
+ 'use strict';
+
+ var all_versions = {
+ '3.4': 'dev (3.4)',
+ '3.3': '3.3',
+ '3.2': '3.2',
+ '2.7': '2.7',
+ '2.6': '2.6'
+ };
+
+ function build_select(current_version, current_release) {
+ var buf = ['<select>'];
+
+ $.each(all_versions, function(version, title) {
+ buf.push('<option value="' + version + '"');
+ if (version == current_version)
+ buf.push(' selected="selected">' + current_release + '</option>');
+ else
+ buf.push('>' + title + '</option>');
+ });
+
+ buf.push('</select>');
+ return buf.join('');
+ }
+
+ function patch_url(url, new_version) {
+ var url_re = /\.org\/(\d|py3k|dev|((release\/)?\d\.\d[\w\d\.]*))\//,
+ new_url = url.replace(url_re, '.org/' + new_version + '/');
+
+ if (new_url == url && !new_url.match(url_re)) {
+ // python 2 url without version?
+ new_url = url.replace(/\.org\//, '.org/' + new_version + '/');
+ }
+ return new_url;
+ }
+
+ function on_switch() {
+ var selected = $(this).children('option:selected').attr('value');
+
+ var url = window.location.href,
+ new_url = patch_url(url, selected);
+
+ if (new_url != url) {
+ // check beforehand if url exists, else redirect to version's start page
+ $.get(new_url, function() {
+ window.location.href = new_url;
+ }).error(function() {
+ window.location.href = 'http://docs.python.org/' + selected;
+ });
+ }
+ }
+
+ $(document).ready(function() {
+ var select = build_select(DOCUMENTATION_OPTIONS.VERSION,
+ DOCUMENTATION_OPTIONS.RELEASE);
+ $('.version_switcher_placeholder').html(select);
+ $('.version_switcher_placeholder select').bind('change', on_switch);
+ });
+})();