summaryrefslogtreecommitdiff
path: root/Doc/README.rst
diff options
context:
space:
mode:
authorJulien Palard <julien@palard.fr>2019-06-15 20:25:03 +0200
committerNed Deily <nad@python.org>2019-06-15 14:25:02 -0400
commit78309c9a09c896b30918ef1732df910e33cdaee1 (patch)
tree66755d1323400d91cb1c2ad26fa5230e05faa983 /Doc/README.rst
parent1af68a65194a26d959161df33fc25ade7f812009 (diff)
downloadcpython-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>
Diffstat (limited to 'Doc/README.rst')
-rw-r--r--Doc/README.rst9
1 files changed, 9 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
============