From 84867166ec13d75c07809813588344054095d128 Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Sat, 13 Jul 2019 16:46:56 +0200 Subject: [PATCH] [3.5] Doc: Add an optional obsolete header. (GH-13638). (#13658) * [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 4f8e9f8f14..f245d6164f 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 c2106678ac..7a7feb52e1 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 current stable release{% endtrans %}. +
+{%- endif %} +{% endblock %} + {% block rootrellink %}
  • -- 2.40.0