diff options
author | Julien Palard <julien@palard.fr> | 2019-06-15 20:25:03 +0200 |
---|---|---|
committer | Ned Deily <nad@python.org> | 2019-06-15 14:25:02 -0400 |
commit | 78309c9a09c896b30918ef1732df910e33cdaee1 (patch) | |
tree | 66755d1323400d91cb1c2ad26fa5230e05faa983 | |
parent | 1af68a65194a26d959161df33fc25ade7f812009 (diff) | |
download | cpython-git-78309c9a09c896b30918ef1732df910e33cdaee1.tar.gz |
[3.6] Doc: Add an optional obsolete header. (GH-13638). (GH-13657)
(cherry picked from commit 46ed90dd014010703c7a3b2a61c4927644fa8210)
Co-authored-by: Julien Palard <julien@palard.fr>
-rw-r--r-- | Doc/README.rst | 9 | ||||
-rw-r--r-- | Doc/tools/templates/layout.html | 11 |
2 files changed, 20 insertions, 0 deletions
diff --git a/Doc/README.rst b/Doc/README.rst index d7bcc5ba79..9fc39834f8 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. + Contributing ============ diff --git a/Doc/tools/templates/layout.html b/Doc/tools/templates/layout.html index c2106678ac..e7c5d92c88 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>. +</div> +{%- endif %} +{% endblock %} + {% block rootrellink %} <li><img src="{{ pathto('_static/py.png', 1) }}" alt="" style="vertical-align: middle; margin-top: -1px"/></li> |