Skip to content

[WIP] Add warning about old versions #28

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

Closed
JulienPalard wants to merge 3 commits into from
Closed

[WIP] Add warning about old versions #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
073cf9b
Add a proto for the deprecation warning for the former version of Python
matrixise May 8, 2019
4179fba
Conditionally write an outdated message with a link to newest availab…
JulienPalard May 8, 2019
bca037d
Generic version, documented.
JulienPalard May 8, 2019
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
28 changes: 28 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,31 @@ trust.
To use the theme, install it into your docs build environment via ``pip``::

pip install python-docs-theme


Features
========

Outdated redirection
--------------------

You can define the ``outdated_message`` and ``outdated_link_text``
variables to show a red banner on each page redirecting to the "latest"
version.

The ``outdated_message`` comes first, the ``outdated_link_text`` comes
afterwards and is the one user can click. When clicking on
``outdated_link_text``, they will be redirected to the same page
stripped from any prefix.

Meaning if they're on ``/2.7/``, they'll go to ``/``, if they're on
``/2.7/tutorial/`` they'll go to ``/tutorial/``.

Sadly it also mean that if you're on ``/fr/3.7/c-api/`` you'll be
redirected to ``/c-api/``, but as we don't know your URL patterns we
can't really do better.

You can personalize the URL by redefining the ``outdated_href`` block,
by default it contains::

/{{ pagename }}{{ file_suffix }}
9 changes: 9 additions & 0 deletions python_docs_theme/layout.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,14 @@
{% extends "classic/layout.html" %}

{% block header %}
{%- if outdated_message is defined and outdated_link_text is defined %}
<div id="outdated-warning" class="doc-floating-warning">
{{ outdated_message }}
<a href="{% block outdated_href %}/{{ pagename }}{{ file_suffix }}{% endblock %}">{{ outdated_link_text }}</a>.
</div>
{%- endif %}
{% endblock %}

{% block rootrellink %}
<li><img src="{{ pathto('_static/' + theme_root_icon, 1) }}" alt=""
style="vertical-align: middle; margin-top: -1px"/></li>
Expand Down
7 changes: 7 additions & 0 deletions python_docs_theme/static/pydoctheme.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,3 +195,10 @@ div.footer a:hover {
dl > dt span ~ em {
font-family: monospace, sans-serif;
}

#outdated-warning {
padding: .5em;
text-align: center;
background-color: #FFBABA;
color: #6A0E0E;
}