Remove Sphinx as a required dependency (#11)

Signed-off-by: Ryan Northey <[email protected]>
Co-authored-by: Adam Turner <[email protected]>

Author: phlax

.github/workflows/test.yml

@@ -44,7 +44,7 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install .[test]
+          python -m pip install .[test,standalone]
 
       - name: Test with pytest
         run: python -m pytest -vv --durations 25

CHANGES

@@ -1,3 +1,10 @@
+Release 1.0.6 (unreleased)
+==========================
+
+* Remove Sphinx as a required dependency, as circular dependencies may cause
+  failure with package managers that expect a directed acyclic graph (DAG)
+  of dependencies.
+
 Release 1.0.5 (2023-08-14)
 ==========================
 

pyproject.toml

@@ -39,9 +39,7 @@ classifiers = [
     "Topic :: Text Processing",
     "Topic :: Utilities",
 ]
-dependencies = [
-    "Sphinx>=5",
-]
+dependencies = []
 dynamic = ["version"]
 
 [project.optional-dependencies]
@@ -53,6 +51,9 @@ lint = [
     "mypy",
     "docutils-stubs",
 ]
+standalone = [
+    "Sphinx>=5",
+]
 
 [[project.authors]]
 name = "Georg Brandl"

sphinxcontrib/devhelp/__init__.py

@@ -129,6 +129,7 @@ def write_index(title: str, refs: list[Any], subitems: Any) -> None:
 
 
 def setup(app: Sphinx) -> dict[str, Any]:
+    app.require_sphinx('5.0')
     app.setup_extension('sphinx.builders.html')
     app.add_builder(DevhelpBuilder)
     app.add_message_catalog(__name__, path.join(package_dir, 'locales'))