]> granicus.if.org Git - python/commitdiff
Doc: Add an optional obsolete header. (GH-13638)
authorJulien Palard <julien@palard.fr>
Wed, 29 May 2019 16:34:04 +0000 (18:34 +0200)
committerGitHub <noreply@github.com>
Wed, 29 May 2019 16:34:04 +0000 (18:34 +0200)
Doc/README.rst
Doc/tools/templates/layout.html

index 31f8a8b7f59328e6c72fa6d461359aacf63c6bd6..380ea4fa9b26ad338e79bf817b2317227615a044 100644 (file)
@@ -113,6 +113,15 @@ Then, from the ``Doc`` directory, run ::
 where ``<builder>`` is one of html, text, latex, or htmlhelp (for explanations
 see the make targets above).
 
+Deprecation header
+==================
+
+You can define the ``outdated`` variable in ``html_context`` to show a
+red banner on each page redirecting to the "latest" version.
+
+The link points to the same page on ``/3/``, sadly for the moment the
+language is lost during the process.
+
 
 Contributing
 ============
index c3992245614082c7a87f4f17feaed2d1d9ad95d5..a765a5de8a2dfba114e9aad220474b3c572f8c70 100644 (file)
@@ -1,5 +1,15 @@
 {% extends "!layout.html" %}
 
+{% block header %}
+{%- if outdated %}
+<div id="outdated-warning" style="padding: .5em; text-align: center; background-color: #FFBABA; color: #6A0E0E;">
+    {% trans %}This document is for an old version of Python that is no longer supported.
+    You should upgrade, and read the {% endtrans %}
+    <a href="/3/{{ pagename }}{{ file_suffix }}">{% trans %} Python documentation for the last stable release {% endtrans %}</a>.
+</div>
+{%- endif %}
+{% endblock %}
+
 {% block rootrellink %}
 {{ super() }}
     <li>