Skip to content

Commit

Permalink
[3.7] Doc: Add an optional obsolete header. (GH-13638). (GH-13655)
Browse files Browse the repository at this point in the history
* [3.7] Doc: Add an optional obsolete header. (GH-13638).
(cherry picked from commit 46ed90d)

Co-authored-by: Julien Palard <julien@palard.fr>
  • Loading branch information
JulienPalard authored and ned-deily committed Jun 15, 2019
1 parent 81fecf7 commit 159ae24
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
9 changes: 9 additions & 0 deletions Doc/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
============
Expand Down
11 changes: 11 additions & 0 deletions Doc/tools/templates/layout.html
Original file line number Diff line number Diff line change
@@ -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>
Expand Down

0 comments on commit 159ae24

Please sign in to comment.