[Python-checkins] [3.7] Doc: Add an optional obsolete header. (GH-13638). (GH-13655)

Ned Deily webhook-mailer at python.org
Sat Jun 15 14:27:14 EDT 2019

commit: 159ae24895272dce5fd53dd8e54809743e4f394f
branch: 3.7
author: Julien Palard <julien at palard.fr>
committer: Ned Deily <nad at python.org>
date: 2019-06-15T14:27:10-04:00

[3.7] Doc: Add an optional obsolete header. (GH-13638). (GH-13655)

* [3.7] Doc: Add an optional obsolete header. (GH-13638).
(cherry picked from commit 46ed90dd014010703c7a3b2a61c4927644fa8210)

Co-authored-by: Julien Palard <julien at palard.fr>

M Doc/README.rst
M Doc/tools/templates/layout.html

diff --git a/Doc/README.rst b/Doc/README.rst
index d7bcc5ba7919..9fc39834f8b5 100644
--- a/Doc/README.rst
+++ b/Doc/README.rst
@@ -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.
diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html
index 8cf903dec6ef..1ea681cdcf2e 100644
--- a/Doc/tools/templates/layout.html
+++ b/Doc/tools/templates/layout.html
@@ -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>.
+{%- endif %}
+{% endblock %}
 {% block rootrellink %}
         <li><img src="{{ pathto('_static/py.png', 1) }}" alt=""
                  style="vertical-align: middle; margin-top: -1px"/></li>

More information about the Python-checkins mailing list