Skip to content

[2.7] Doc: Add an optional obsolete header. (GH-13638) #19229

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
benjaminp merged 9 commits into from
Apr 18, 2020
Merged

[2.7] Doc: Add an optional obsolete header. (GH-13638) #19229

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
b47d9bc
[2.7] Doc: Add an optional obsolete header. (GH-13638)
leonardr Mar 30, 2020
f93d321
Use the more precise wording set in revision 525e408.
leonardr Mar 30, 2020
5276022
Added a link to the document that lists the status of Python branches.
leonardr Apr 9, 2020
fa07217
Link 'no longer supported' to the table of end-of-life branches rathe…
leonardr Apr 11, 2020
50e2dbd
Add a language code to the URL of the up-to-date documentation, if ap…
leonardr Apr 16, 2020
a8d7d7f
Change README to reflect the fact that language is now preserved thro…
leonardr Apr 16, 2020
25567b7
Always set 'outdated' in the HTML context, because Python 2.7 docs ar…
leonardr Apr 17, 2020
0f373bc
When linking to the latest version of a documentation file, link to a…
leonardr Apr 17, 2020
3628e76
Reword the portion of the README referring to the deprecation banner,…
leonardr Apr 17, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions Doc/README.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,13 @@ 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
==================

Following the sunsetting of Python 2.7, a red banner displays at the
top of each page redirecting to the corresponding page on
``https://docs.python.org/3/``.


Contributing
============
Expand Down
4 changes: 4 additions & 0 deletions Doc/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,10 @@
# Split the index
html_split_index = True

html_context = {
'outdated': True
}


# Options for LaTeX output
# ------------------------
Expand Down
10 changes: 10 additions & 0 deletions Doc/tools/templates/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
{% 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 {% endtrans %}<a href="https://devguide.python.org/devcycle/#end-of-life-branches">{% trans %}no longer supported{% endtrans %}</a>.
{% trans %}You should upgrade, and read the {% endtrans %}
<a href="https://docs.python.org/{{ language + '/' if language and language != 'en' else '' }}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