diff options
| author | Julien Palard <julien@palard.fr> | 2019-05-29 16:34:04 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-29 16:34:04 (GMT) |
| commit | 46ed90dd014010703c7a3b2a61c4927644fa8210 (patch) | |
| tree | eb3b58ab720899e84bed20ab306d89c93c92dfd0 | |
| parent | 1c999262281c4a946c49614c3f8549f68049c0d9 (diff) | |
| download | cpython-46ed90dd014010703c7a3b2a61c4927644fa8210.zip cpython-46ed90dd014010703c7a3b2a61c4927644fa8210.tar.gz cpython-46ed90dd014010703c7a3b2a61c4927644fa8210.tar.bz2 | |
Doc: Add an optional obsolete header. (GH-13638)
| -rw-r--r-- | Doc/README.rst | 9 | ||||
| -rw-r--r-- | Doc/tools/templates/layout.html | 10 |
2 files changed, 19 insertions, 0 deletions
diff --git a/Doc/README.rst b/Doc/README.rst index 31f8a8b..380ea4f 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 c399224..a765a5d 100644 --- a/Doc/tools/templates/layout.html +++ b/Doc/tools/templates/layout.html @@ -1,5 +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 last stable release {% endtrans %}</a>. +</div> +{%- endif %} +{% endblock %} + {% block rootrellink %} {{ super() }} <li> |