diff options
| author | Julien Palard <julien@palard.fr> | 2019-06-15 20:27:11 +0200 |
|---|---|---|
| committer | Ned Deily <nad@python.org> | 2019-06-15 14:27:10 -0400 |
| commit | 159ae24895272dce5fd53dd8e54809743e4f394f (patch) | |
| tree | ef670e92c7cfa43d9e476c8e879cda24a6e5a8db | |
| parent | 81fecf7b7a6e766a213c6e670219c1da52461589 (diff) | |
| download | cpython-git-159ae24895272dce5fd53dd8e54809743e4f394f.tar.gz | |
[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@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 8cf903dec6..1ea681cdcf 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> |