Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
Also use a more modern theme (from pallets-sphinx-themes)
  • Loading branch information
edschofield committed Feb 21, 2024
1 parent e32250e commit a7097f8
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/_templates/sidebarintro.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!--<h3>Python-Future</h3>
<p>-->
<h4>Easy, clean, reliable Python 2/3 compatibility</h4>
<a href="https://python-future.org">Table of Contents</a>
<a href="https://python-future.org/#contents">Table of Contents</a>
<!--
</p>
<h3>Other Formats</h3>
Expand Down
2 changes: 1 addition & 1 deletion docs/_templates/sidebartoc.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
{{ toctree(maxdepth=2, collapse=True, includehidden=True) }}
7 changes: 4 additions & 3 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

from __future__ import absolute_import, print_function
import sys, os
import sphinx_bootstrap_theme
# import sphinx_bootstrap_theme

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
Expand All @@ -32,6 +32,7 @@
'sphinx.ext.intersphinx',
'sphinx.ext.ifconfig',
'sphinx.ext.viewcode',
'pallets_sphinx_themes',
# 'sphinxcontrib.napoleon' # see https://sphinxcontrib-napoleon.readthedocs.io/
# 'sphinx.ext.napoleon' # use this in Sphinx 1.3+
]
Expand Down Expand Up @@ -100,8 +101,8 @@

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = 'bootstrap'
html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()
html_theme = 'jinja'
# html_theme_path = sphinx_bootstrap_theme.get_html_theme_path()

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
Expand Down
8 changes: 4 additions & 4 deletions docs/contents.rst.inc
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Contents:
---------
Contents
========

.. toctree::
:maxdepth: 2
:maxdepth: 3

whatsnew
overview
Expand All @@ -19,7 +19,7 @@ Contents:
reference

Indices and tables
------------------
******************

* :ref:`genindex`
* :ref:`modindex`
Expand Down
13 changes: 4 additions & 9 deletions docs/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -118,10 +118,7 @@ Maturity
How well has it been tested?
----------------------------

``future`` is used by several major projects, including `mezzanine
<http://mezzanine.jupo.org>`_ and `ObsPy <http://www.obspy.org>`_. It is also
currently being used to help with porting 800,000 lines of Python 2 code in
`Sage <http://sagemath.org>`_ to Python 2/3.
``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.

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

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

..
Are there any example of Python 2 packages ported to Python 3 using ``future`` and ``futurize``?
Expand Down Expand Up @@ -288,7 +283,7 @@ Support
Is there a mailing list?
------------------------

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


.. _contributing:
Expand Down
6 changes: 3 additions & 3 deletions docs/other/upload_future_docs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ touch ~/shared/python-future-html-docs.zip
rm ~/shared/python-future-html-docs.zip
zip -r ~/shared/python-future-html-docs.zip *

scp ~/shared/python-future-html-docs.zip python-future.org:
scp ~/shared/cheatsheet.pdf python-future.org:
ssh python-future.org
scp ~/shared/python-future-html-docs.zip ubuntu@python-future.org:
scp ~/shared/cheatsheet.pdf ubuntu@python-future.org:
ssh ubuntu@python-future.org


# On the remote machine:
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
sphinx==3.2.1
sphinx_bootstrap_theme==0.7.1
Pallets-Sphinx-Themes==2.2.1
setuptools==65.5.1

0 comments on commit a7097f8

Please sign in to comment.