]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.6] Doc: Add an optional obsolete header. (GH-13638). (GH-13657)
authorJulien Palard <julien@palard.fr>
Sat, 15 Jun 2019 18:25:03 +0000 (20:25 +0200)
committerNed Deily <nad@python.org>
Sat, 15 Jun 2019 18:25:02 +0000 (14:25 -0400)
(cherry picked from commit 46ed90dd014010703c7a3b2a61c4927644fa8210)

Co-authored-by: Julien Palard <julien@palard.fr>
Doc/README.rst
Doc/tools/templates/layout.html

index d7bcc5ba7919bbe4d3306fa3fc0910c3fb32f2aa..9fc39834f8b5433f8a5a2b0066f8afd5cbc2cf57 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 c2106678ac60f4dcb82212a59087a5f8604df3a6..e7c5d92c888f8b7fbfca7873f1522cfe261ceb2f 100644 (file)
@@ -1,4 +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 current stable release {% endtrans %}</a>.
+</div>
+{%- endif %}
+{% endblock %}
+
 {% block rootrellink %}
         <li><img src="{{ pathto('_static/py.png', 1) }}" alt=""
                  style="vertical-align: middle; margin-top: -1px"/></li>