From 48cecd91c1a4f6fbb93e9d54e24402a479bfa1c1 Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Wed, 29 May 2019 18:34:04 +0200 Subject: [PATCH 1/3] [3.5] Doc: Add an optional obsolete header. (GH-13638). (cherry picked from commit 46ed90dd014010703c7a3b2a61c4927644fa8210) Co-authored-by: Julien Palard --- Doc/README.txt | 9 +++++++++ Doc/tools/templates/layout.html | 11 +++++++++++ 2 files changed, 20 insertions(+) diff --git a/Doc/README.txt b/Doc/README.txt index 4f8e9f8f1417fb..f245d6164f5b7a 100644 --- a/Doc/README.txt +++ b/Doc/README.txt @@ -104,6 +104,15 @@ Then, from the ``Doc`` directory, run :: where ```` 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 ============ diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html index c2106678ac60f4..504ab85e42992f 100644 --- a/Doc/tools/templates/layout.html +++ b/Doc/tools/templates/layout.html @@ -1,4 +1,15 @@ {% extends "!layout.html" %} + +{% block header %} +{%- if outdated %} +
+ {% trans %}This document is for an old version of Python that is no longer supported. + You should upgrade, and read the {% endtrans %} + {% trans %} Python documentation for the last stable release {% endtrans %}. +
+{%- endif %} +{% endblock %} + {% block rootrellink %}
  • From 4f0e9a3cafd85156624c559092e3fff29b1cf3aa Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Sat, 15 Jun 2019 15:50:16 +0200 Subject: [PATCH 2/3] Doc: Deprecation header: More precise wording. --- Doc/tools/templates/layout.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html index 504ab85e42992f..e7c5d92c888f8b 100644 --- a/Doc/tools/templates/layout.html +++ b/Doc/tools/templates/layout.html @@ -5,7 +5,7 @@
    {% trans %}This document is for an old version of Python that is no longer supported. You should upgrade, and read the {% endtrans %} - {% trans %} Python documentation for the last stable release {% endtrans %}. + {% trans %} Python documentation for the current stable release {% endtrans %}.
    {%- endif %} {% endblock %} From bef745ea085ffd2e52d498ef53cd6a78801cc3d1 Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Sun, 16 Jun 2019 10:13:55 +0200 Subject: [PATCH 3/3] Doc: Remove an ugly space before a dot. --- Doc/tools/templates/layout.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html index e7c5d92c888f8b..7a7feb52e1a3e8 100644 --- a/Doc/tools/templates/layout.html +++ b/Doc/tools/templates/layout.html @@ -5,7 +5,7 @@
    {% trans %}This document is for an old version of Python that is no longer supported. You should upgrade, and read the {% endtrans %} - {% trans %} Python documentation for the current stable release {% endtrans %}. + {% trans %} Python documentation for the current stable release{% endtrans %}.
    {%- endif %} {% endblock %}