- switch to "furo" Sphinx theme as suggested by Steve Piercy

zopefoundation · Aug 7, 2024 · dcf940c · dcf940c
1 parent aac3ea5
commit dcf940c
Show file tree

Hide file tree

Showing 10 changed files with 9 additions and 28 deletions.
diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst
@@ -4,9 +4,6 @@ This document describes installing Zope with
 `zc.buildout <https://pypi.org/project/zc.buildout/>`_
 (the **recommended** method) or via ``pip``.
 
-.. contents::
-   :local:
-
 
 Prerequisites
 -------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -56,7 +56,7 @@
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = {'.rst': 'restructuredtext'}
 
 # The master toctree document.
 master_doc = 'index'
@@ -82,7 +82,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'sphinx_rtd_theme'
+html_theme = 'furo'
 
 # 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/maintenance.rst b/docs/maintenance.rst
@@ -6,7 +6,6 @@ Maintainer information
   This is internal documentation, mostly for Zope maintainers who manage
   software releases and the documentation
 
-.. contents::
 
 Release process
 ---------------

diff --git a/docs/migrations/zope4/code.rst b/docs/migrations/zope4/code.rst
@@ -5,9 +5,6 @@ Migrating Zope product code
 The following list shows a few common migration issues independent of the
 Python version used.
 
-.. contents::
-   :local:
-
 
 Changed import paths
 --------------------

diff --git a/docs/migrations/zope4/zodb.rst b/docs/migrations/zope4/zodb.rst
@@ -14,9 +14,6 @@ into a Zope 4 environment. The migration example steps have been tested on a
    on a copy of your ZODB so you retain a working copy for Zope 2 if you need
    to go back.
 
-.. contents::
-   :local:
-
 
 Pre-migration steps on Zope 2
 -----------------------------

diff --git a/docs/news.rst b/docs/news.rst
@@ -15,10 +15,6 @@ supported and for how long.
     :ref:`zope4migration` documentation
 
 
-.. contents::
-   :local:
-
-
 What's new in Zope 5
 --------------------
 

diff --git a/docs/operation.rst b/docs/operation.rst
@@ -11,9 +11,6 @@ Whichever method you used to install Zope and create a server instance (see
    slightly. You can immediately skip down to `Running Zope
    (plone.recipe.zope2instance install)`.
 
-.. contents::
-   :local:
-
 
 Creating a Zope instance
 ------------------------

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,5 +1,4 @@
 Sphinx
-sphinx_rtd_theme>1
-docutils<0.19
+furo
 ZConfig
 tempstorage
diff --git a/setup.py b/setup.py
@@ -128,7 +128,7 @@ def _read_file(filename):
     extras_require={
         'docs': [
             'Sphinx',
-            'sphinx_rtd_theme',
+            'furo',
             'tempstorage',
         ],
         'wsgi': [

diff --git a/versions.cfg b/versions.cfg
@@ -13,15 +13,15 @@ Products.BTreeFolder2 = 5.1
 Products.ZCatalog = 7.1
 Pygments = 2.18.0
 Record = 4.1
-Sphinx = 7.4.7
-alabaster = 0.7.16
+Sphinx = 8.0.2
+alabaster = 1.0.0
 certifi = 2024.7.4
 charset-normalizer = 3.3.2
 collective.recipe.template = 2.2
 colorama = 0.4.6
-# sphinx-rtd-theme 2.0.0 requires docutils <21
-docutils = 0.20.1
+docutils = 0.21.2
 five.localsitemanager = 4.0
+furo = 2024.8.6
 idna = 3.7
 imagesize = 1.4.1
 importlib-metadata = 8.2.0
@@ -32,11 +32,10 @@ packaging = 24.1
 plone.recipe.command = 1.1
 requests = 2.32.3
 snowballstemmer = 2.2.0
-sphinx-rtd-theme = 2.0.0
+sphinx-basic-ng = 1.0.0b2
 sphinxcontrib-applehelp = 2.0.0
 sphinxcontrib-devhelp = 2.0.0
 sphinxcontrib-htmlhelp = 2.1.0
-sphinxcontrib-jquery = 4.1
 sphinxcontrib-jsmath = 1.0.1
 sphinxcontrib-qthelp = 2.0.0
 sphinxcontrib-serializinghtml = 2.0.0