Merge pull request #892 from sphinx-contrib/maintenance-2024-02-26

Maintenance (2024-02-26)

AUTHORS

@@ -29,6 +29,7 @@ Paul D.Smith <paul@pauldsmith.org.uk>
 Pawel Limanowka <plimanowka@gmail.com>
 Richard Vodden <richard@humanisingautonomy.com>
 Sydney Jones <sydney.u.jones@gmail.com>
+TheDubliner <chez.eskay@gmail.com>
 Thomas Malcher <malcher@student.tugraz.at>
 Toni Ruža <toni.ruza@gmail.com>
 Tsvi Mostovicz <ttmost@gmail.com>

pyproject.toml

@@ -37,8 +37,8 @@ classifiers = [
     'Topic :: Utilities',
 ]
 dependencies = [
-    'requests>=2.14.0',
-    'sphinx>=5.0',
+    'requests>=2.25.0',
+    'sphinx>=6.1',
 ]
 dynamic = [
     'version',

sphinxcontrib/confluencebuilder/__init__.py

@@ -52,7 +52,7 @@ def setup(app):
     ConfluenceLogger.initialize()
     cm = app.config_manager_ = ConfigManager(app)
 
-    app.require_sphinx('1.8')
+    app.require_sphinx('6.1')
     app.add_builder(ConfluenceBuilder)
     app.add_builder(ConfluenceReportBuilder)
     app.add_builder(SingleConfluenceBuilder)

sphinxcontrib/confluencebuilder/assets.py

@@ -76,7 +76,7 @@ def add(self, path, docname):
         intersphinx database).
 
         Args:
-            path: the path of the fiel
+            path: the path of the file
             docname: the document's name to attach to
 
         Returns:

sphinxcontrib/confluencebuilder/builder.py

@@ -7,13 +7,12 @@
 from docutils.io import StringOutput
 from pathlib import Path
 from sphinx import addnodes
-from sphinx import version_info as sphinx_version_info
 from sphinx.builders import Builder
 from sphinx.locale import _ as SL
+from sphinx.util.display import status_iterator
 from sphinxcontrib.confluencebuilder.assets import ConfluenceAssetManager
 from sphinxcontrib.confluencebuilder.assets import ConfluenceSupportedImages
 from sphinxcontrib.confluencebuilder.compat import docutils_findall as findall
-from sphinxcontrib.confluencebuilder.compat import status_iterator
 from sphinxcontrib.confluencebuilder.config import process_ask_configs
 from sphinxcontrib.confluencebuilder.config.checks import validate_configuration
 from sphinxcontrib.confluencebuilder.config.defaults import apply_defaults
@@ -54,15 +53,7 @@ class ConfluenceBuilder(Builder):
     supported_remote_images = True
 
     def __init__(self, app, env=None):
-        # As of Sphinx v5.1.0, builders will accept an `env` option to
-        # configure against an environment (over later having an environment
-        # assigned.
-        if sphinx_version_info >= (5, 1):
-            # pylint: disable=too-many-function-args
-            super().__init__(app, env)
-            # pylint: enable=too-many-function-args
-        else:
-            super().__init__(app)  # pylint: disable=E1120
+        super().__init__(app, env)
 
         self.cache_doctrees = {}
         self.cloud = False

sphinxcontrib/confluencebuilder/compat.py

@@ -11,15 +11,6 @@
 from sphinxcontrib.confluencebuilder.logger import ConfluenceLogger as logger
 from typing import cast
 
-# pylint: disable=no-name-in-module
-if sphinx_version_info >= (6, 1):
-    from sphinx.util.display import status_iterator  # noqa: F401
-    from sphinx.util.display import progress_message  # noqa: F401
-else:
-    from sphinx.util import status_iterator  # noqa: F401
-    from sphinx.util import progress_message  # noqa: F401
-# pylint: enable=no-name-in-module
-
 
 # use docutil's findall call over traverse (obsolete)
 def docutils_findall(doctree, *args, **kwargs):

sphinxcontrib/confluencebuilder/singlebuilder.py

@@ -4,10 +4,10 @@
 
 from docutils import nodes
 from sphinx.util.console import darkgreen  # pylint: disable=no-name-in-module
+from sphinx.util.display import progress_message
 from sphinxcontrib.confluencebuilder.builder import ConfluenceBuilder
 from sphinxcontrib.confluencebuilder.compat import docutils_findall as findall
 from sphinxcontrib.confluencebuilder.compat import inline_all_toctrees
-from sphinxcontrib.confluencebuilder.compat import progress_message
 from sphinxcontrib.confluencebuilder.locale import C
 from sphinxcontrib.confluencebuilder.logger import ConfluenceLogger as logger