- use furo Sphinx theme and clean up some obsolete docs and settings

zopefoundation · Oct 9, 2024 · 89a76f0 · 89a76f0
1 parent 9622048
commit 89a76f0
Show file tree

Hide file tree

Showing 8 changed files with 15 additions and 45 deletions.
diff --git a/.meta.toml b/.meta.toml
@@ -81,6 +81,7 @@ additional-ignores = [
     "docs/_build/html/_sources/roadmap/*",
     "docs/_build/html/_sources/upgrade_dependencies/*",
     "docs/_build/html/_sources/usage/*",
+    "docs/_build/html/_static/scripts/*",
     ]
 
 [github-actions]

diff --git a/docs/conf.py b/docs/conf.py
@@ -16,8 +16,13 @@
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 # sys.path.insert(0, os.path.abspath('.'))
 
+import datetime
+
+
 # -- General configuration ------------------------------------------------
 
+year = datetime.datetime.now().year
+
 # If your documentation needs a minimal Sphinx version, state it here.
 # needs_sphinx = '1.0'
 
@@ -47,17 +52,17 @@
 
 # General information about the project.
 project = 'RestrictedPython'
-copyright = '2017-2023, Zope Foundation and Contributors'
+copyright = f'2017-{year}, Zope Foundation and Contributors'
 author = 'The Zope & Plone developer community'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '7.0'
+version = '7.4'
 # The full version, including alpha/beta/rc tags.
-release = '7.0'
+release = '7.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -123,7 +128,7 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+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/contributing/index.rst b/docs/contributing/index.rst
@@ -1,7 +1,6 @@
 Contributing
 ============
 
-.. contents::
 
 Contributing to RestrictedPython
 --------------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -29,8 +29,6 @@ Contents
    usage/index
    usage/api
 
-   upgrade_dependencies/index
-
    roadmap/index
    contributing/index
 

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1 +1,2 @@
 Sphinx
+furo
diff --git a/docs/upgrade_dependencies/index.rst b/docs/upgrade_dependencies/index.rst
diff --git a/setup.cfg b/setup.cfg
@@ -17,6 +17,7 @@ ignore =
     docs/_build/html/_sources/roadmap/*
     docs/_build/html/_sources/upgrade_dependencies/*
     docs/_build/html/_sources/usage/*
+    docs/_build/html/_static/scripts/*
 
 [isort]
 force_single_line = True

diff --git a/setup.py b/setup.py
@@ -24,11 +24,6 @@ def read(*rnames):
         return f.read()
 
 
-tests_require = [
-    'pytest',
-    'pytest-mock',
-]
-
 setup(name='RestrictedPython',
       version='7.4.dev0',
       url='https://github.com/zopefoundation/RestrictedPython',
@@ -55,7 +50,7 @@ def read(*rnames):
       ],
       keywords='restricted execution security untrusted code',
       author='Zope Foundation and Contributors',
-      author_email='zope-dev@zope.org',
+      author_email='zope-dev@zope.dev',
       project_urls={
           "Documentation": "https://restrictedpython.readthedocs.io/",
           "Source": "https://github.com/zopefoundation/RestrictedPython",
@@ -67,8 +62,8 @@ def read(*rnames):
       install_requires=[],
       python_requires=">=3.8, <3.14",
       extras_require={
-          'test': tests_require,
-          'docs': ['Sphinx', 'sphinx_rtd_theme'],
+          'test': ['pytest', 'pytest-mock'],
+          'docs': ['Sphinx', 'furo'],
       },
       include_package_data=True,
       zip_safe=False)