From a7097f804cd83fe1fd6a50ab088ae1d4ab303246 Mon Sep 17 00:00:00 2001
From: Ed Schofield <ed@pythoncharmers.com>
Date: Wed, 21 Feb 2024 22:33:43 +1100
Subject: [PATCH] Update docs

Also use a more modern theme (from pallets-sphinx-themes)
---
 docs/_templates/sidebarintro.html |  2 +-
 docs/_templates/sidebartoc.html   |  2 +-
 docs/conf.py                      |  7 ++++---
 docs/contents.rst.inc             |  8 ++++----
 docs/faq.rst                      | 13 ++++---------
 docs/other/upload_future_docs.sh  |  6 +++---
 docs/requirements.txt             |  2 +-
 7 files changed, 18 insertions(+), 22 deletions(-)

diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html
index 1e1a512f..25325ec3 100644
--- a/docs/_templates/sidebarintro.html
+++ b/docs/_templates/sidebarintro.html
@@ -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>
diff --git a/docs/_templates/sidebartoc.html b/docs/_templates/sidebartoc.html
index 0d119afc..629fb6a1 100644
--- a/docs/_templates/sidebartoc.html
+++ b/docs/_templates/sidebartoc.html
@@ -1 +1 @@
-{{ toctree(maxdepth=theme_globaltoc_depth|toint, collapse=True, includehidden=theme_globaltoc_includehidden|tobool) }}
+{{ toctree(maxdepth=2, collapse=True, includehidden=True) }}
diff --git a/docs/conf.py b/docs/conf.py
index 6f00536b..cf4606c7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -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
@@ -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+
              ]
@@ -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
diff --git a/docs/contents.rst.inc b/docs/contents.rst.inc
index 7c9bbf2f..869b3642 100644
--- a/docs/contents.rst.inc
+++ b/docs/contents.rst.inc
@@ -1,8 +1,8 @@
-Contents:
----------
+Contents
+========
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 3
 
    whatsnew
    overview
@@ -19,7 +19,7 @@ Contents:
    reference
 
 Indices and tables
-------------------
+******************
 
 * :ref:`genindex`
 * :ref:`modindex`
diff --git a/docs/faq.rst b/docs/faq.rst
index 2ac148d3..e49adf61 100644
--- a/docs/faq.rst
+++ b/docs/faq.rst
@@ -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.
@@ -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``?
@@ -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:
diff --git a/docs/other/upload_future_docs.sh b/docs/other/upload_future_docs.sh
index c5201f90..04470f3f 100644
--- a/docs/other/upload_future_docs.sh
+++ b/docs/other/upload_future_docs.sh
@@ -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:
diff --git a/docs/requirements.txt b/docs/requirements.txt
index de74d8b2..21e670ea 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -1,3 +1,3 @@
 sphinx==3.2.1
-sphinx_bootstrap_theme==0.7.1
+Pallets-Sphinx-Themes==2.2.1
 setuptools==65.5.1