From 46ed90dd014010703c7a3b2a61c4927644fa8210 Mon Sep 17 00:00:00 2001 From: Julien Palard Date: Wed, 29 May 2019 18:34:04 +0200 Subject: [PATCH] Doc: Add an optional obsolete header. (GH-13638) --- Doc/README.rst | 9 +++++++++ Doc/tools/templates/layout.html | 10 ++++++++++ 2 files changed, 19 insertions(+) diff --git a/Doc/README.rst b/Doc/README.rst index 31f8a8b7f59..380ea4fa9b2 100644 --- a/Doc/README.rst +++ b/Doc/README.rst @@ -113,6 +113,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 c3992245614..a765a5de8a2 100644 --- a/Doc/tools/templates/layout.html +++ b/Doc/tools/templates/layout.html @@ -1,5 +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 %} {{ super() }}