Skip to content

Commit a7097f8

Browse files
committed
Update docs
Also use a more modern theme (from pallets-sphinx-themes)
1 parent e32250e commit a7097f8

File tree

7 files changed

+18
-22
lines changed

7 files changed

+18
-22
lines changed

Diff for: docs/_templates/sidebarintro.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!--<h3>Python-Future</h3>
22
<p>-->
33
<h4>Easy, clean, reliable Python 2/3 compatibility</h4>
4-
<a href="https://python-future.org">Table of Contents</a>
4+
<a href="https://python-future.org/#contents">Table of Contents</a>
55
<!--
66
</p>
77
<h3>Other Formats</h3>

Diff for: docs/_templates/sidebartoc.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
1+
{{ toctree(maxdepth=2, collapse=True, includehidden=True) }}

Diff for: docs/conf.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414
from __future__ import absolute_import, print_function
1515
import sys, os
16-
import sphinx_bootstrap_theme
16+
# import sphinx_bootstrap_theme
1717

1818
# If extensions (or modules to document with autodoc) are in another directory,
1919
# add these directories to sys.path here. If the directory is relative to the
@@ -32,6 +32,7 @@
3232
'sphinx.ext.intersphinx',
3333
'sphinx.ext.ifconfig',
3434
'sphinx.ext.viewcode',
35+
'pallets_sphinx_themes',
3536
# 'sphinxcontrib.napoleon' # see https://sphinxcontrib-napoleon.readthedocs.io/
3637
# 'sphinx.ext.napoleon' # use this in Sphinx 1.3+
3738
]
@@ -100,8 +101,8 @@
100101

101102
# The theme to use for HTML and HTML Help pages. See the documentation for
102103
# a list of builtin themes.
103-
html_theme = 'bootstrap'
104-
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
104+
html_theme = 'jinja'
105+
# html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
105106

106107
# Theme options are theme-specific and customize the look and feel of a theme
107108
# further. For a list of options available for each theme, see the

Diff for: docs/contents.rst.inc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
Contents:
2-
---------
1+
Contents
2+
========
33

44
.. toctree::
5-
:maxdepth: 2
5+
:maxdepth: 3
66

77
whatsnew
88
overview
@@ -19,7 +19,7 @@ Contents:
1919
reference
2020

2121
Indices and tables
22-
------------------
22+
******************
2323

2424
* :ref:`genindex`
2525
* :ref:`modindex`

Diff for: docs/faq.rst

+4-9
Original file line numberDiff line numberDiff line change
@@ -118,10 +118,7 @@ Maturity
118118
How well has it been tested?
119119
----------------------------
120120

121-
``future`` is used by several major projects, including `mezzanine
122-
<http://mezzanine.jupo.org>`_ and `ObsPy <http://www.obspy.org>`_. It is also
123-
currently being used to help with porting 800,000 lines of Python 2 code in
124-
`Sage <http://sagemath.org>`_ to Python 2/3.
121+
``future`` is used by thousands of projects and has been downloaded over 1.7 billion times. Some projects like Sage have used it to port 800,000+ lines of Python 2 code to Python 2/3.
125122

126123
Currently ``python-future`` has over 1000 unit tests. Many of these are straight
127124
from the Python 3.3 and 3.4 test suites.
@@ -135,10 +132,8 @@ expanded.
135132
Is the API stable?
136133
------------------
137134

138-
Not yet; ``future`` is still in beta. Where possible, we will try not to break
139-
anything which was documented and used to work. After version 1.0 is released,
140-
the API will not change in backward-incompatible ways until a hypothetical
141-
version 2.0.
135+
Yes; ``future`` is mature. We'll make very few changes from here, trying not to
136+
break anything which was documented and used to work.
142137

143138
..
144139
Are there any example of Python 2 packages ported to Python 3 using ``future`` and ``futurize``?
@@ -288,7 +283,7 @@ Support
288283
Is there a mailing list?
289284
------------------------
290285

291-
There was (`python-porting`), but it's now dead.
286+
There was a `python-porting` mailing list, but it's now dead.
292287

293288

294289
.. _contributing:

Diff for: docs/other/upload_future_docs.sh

+3-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ touch ~/shared/python-future-html-docs.zip
99
rm ~/shared/python-future-html-docs.zip
1010
zip -r ~/shared/python-future-html-docs.zip *
1111

12-
scp ~/shared/python-future-html-docs.zip python-future.org:
13-
scp ~/shared/cheatsheet.pdf python-future.org:
14-
ssh python-future.org
12+
scp ~/shared/python-future-html-docs.zip ubuntu@python-future.org:
13+
scp ~/shared/cheatsheet.pdf ubuntu@python-future.org:
14+
ssh ubuntu@python-future.org
1515

1616

1717
# On the remote machine:

Diff for: docs/requirements.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
sphinx==3.2.1
2-
sphinx_bootstrap_theme==0.7.1
2+
Pallets-Sphinx-Themes==2.2.1
33
setuptools==65.5.1

0 commit comments

Comments
 (0)