Skip to content

Commit 7575afc

Browse files
authored
Merge branch 'master' into issue-16
2 parents c9d8c2e + c2115b3 commit 7575afc

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

README.rst

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,15 @@ projects if you so choose, but please keep in mind that in doing so you're also
1010
choosing to accept some of the responsibility for maintaining that collective
1111
trust.
1212

13-
To use the theme, install it into your docs build environment via ``pip``::
13+
To use the theme, install it into your docs build environment via ``pip``
14+
(preferably in a virtual environment).
1415

15-
pip install python-docs-theme
1616

17-
Configuring the options the conf.py holds
18-
------------------------------------------
17+
Configuration options
18+
---------------------
1919

20-
For implementing the theme you should
21-
- enable `html_theme = 'python_docs_theme'`
22-
- html_sidebars:
23-
- Defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars
20+
To use this theme, add the following to ``conf.py``::
21+
22+
- ``html_theme = 'python_docs_theme'``
23+
24+
- ``html_sidebars``, defaults taken from http://www.sphinx-doc.org/en/stable/config.html#confval-html_sidebars

python_docs_theme/layout.html

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,12 @@
4747
<div class="footer">
4848
&copy; <a href="{{ pathto('copyright') }}">{% trans %}Copyright{% endtrans %}</a> {{ copyright|e }}.
4949
<br />
50+
{% trans %}This page is licensed under the Python Software Foundation License Version 2.{% endtrans %}
51+
<br />
52+
{% trans %}Examples, recipes, and other code in the documentation are additionally licensed under the Zero Clause BSD License.{% endtrans %}
53+
<br />
54+
{% trans pathto_license=license_file %}See <a href="{{ license_file }}">History and License</a> for more information.{% endtrans %}
55+
<br /><br />
5056

5157
{% include "footerdonate.html" %}
5258
<br />
@@ -55,6 +61,6 @@
5561
{% if theme_issues_url %}{% trans pathto_bugs=theme_issues_url %}<a href="{{ theme_issues_url }}">Found a bug</a>?{% endtrans %}{% endif %}
5662
<br />
5763

58-
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
64+
{% trans sphinx_version=sphinx_version|e %}Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
5965
</div>
6066
{% endblock %}

setup.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@
1313
name='python-docs-theme',
1414
# Version is date based as year.month[.serial], where serial is used
1515
# if multiple releases are needed to address build failures.
16-
version='2018.7',
16+
version='2020.1.post1',
1717
description='The Sphinx theme for the CPython docs and related projects',
1818
long_description=long_description,
1919
author='PyPA',
2020
author_email='distutils-sig@python.org',
21-
url='https://docs.python.org',
21+
url='https://github.com/python/python-docs-theme/',
2222
packages=['python_docs_theme'],
2323
include_package_data=True,
2424
entry_points={

0 commit comments

Comments
 (0)