From 7946942744558214d01c95aedc9be81ea32fb728 Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Mon, 21 Aug 2023 00:26:37 +0100 Subject: [PATCH 1/4] deps: Make Sphinx optional Signed-off-by: Ryan Northey --- .github/workflows/test.yml | 1 + pyproject.toml | 6 +++--- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 794d170..3e35172 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -45,6 +45,7 @@ jobs: run: | python -m pip install --upgrade pip python -m pip install .[test] + python -m pip install .[standalone] - name: Test with pytest run: python -m pytest -vv --durations 25 diff --git a/pyproject.toml b/pyproject.toml index 8c39008..79a096b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,9 +40,6 @@ classifiers = [ "Topic :: Text Processing", "Topic :: Utilities", ] -dependencies = [ - "Sphinx>=5", -] dynamic = ["version"] [project.optional-dependencies] @@ -54,6 +51,9 @@ lint = [ "mypy", "docutils-stubs", ] +standalone = [ + "sphinx > 5", +] [[project.authors]] name = "Georg Brandl" From 058c497425808c3df46fd4c2c100e98754e2a98a Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Fri, 1 Sep 2023 11:24:10 +0100 Subject: [PATCH 2/4] updates Signed-off-by: Ryan Northey --- .github/workflows/test.yml | 3 +-- CHANGES | 5 +++++ sphinxcontrib/serializinghtml/__init__.py | 1 + 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 3e35172..8cd7db1 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -44,8 +44,7 @@ jobs: - name: Install dependencies run: | python -m pip install --upgrade pip - python -m pip install .[test] - python -m pip install .[standalone] + python -m pip install .[test,standalone] - name: Test with pytest run: python -m pytest -vv --durations 25 diff --git a/CHANGES b/CHANGES index c91fed7..58729ba 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,8 @@ +Release 1.1.10 (Pending) +========================== + +* Fix circular dependency with Sphinx that caused failure in DAG-based package management + Release 1.1.9 (2023-08-20) ========================== diff --git a/sphinxcontrib/serializinghtml/__init__.py b/sphinxcontrib/serializinghtml/__init__.py index 8940d80..815705c 100644 --- a/sphinxcontrib/serializinghtml/__init__.py +++ b/sphinxcontrib/serializinghtml/__init__.py @@ -157,6 +157,7 @@ class JSONHTMLBuilder(SerializingHTMLBuilder): def setup(app: Sphinx) -> dict[str, Any]: + app.require_sphinx('5.0') app.setup_extension('sphinx.builders.html') app.add_builder(JSONHTMLBuilder) app.add_builder(PickleHTMLBuilder) From aec2b7d7741aaf5511ea26adec1d46c517f87931 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:06:34 +0000 Subject: [PATCH 3/4] Apply suggestions from code review --- CHANGES | 4 ++-- pyproject.toml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CHANGES b/CHANGES index 58729ba..8a2c508 100644 --- a/CHANGES +++ b/CHANGES @@ -1,5 +1,5 @@ -Release 1.1.10 (Pending) -========================== +Release 1.1.10 (unreleased) +=========================== * Fix circular dependency with Sphinx that caused failure in DAG-based package management diff --git a/pyproject.toml b/pyproject.toml index 79a096b..68b81a5 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -52,7 +52,7 @@ lint = [ "docutils-stubs", ] standalone = [ - "sphinx > 5", + "Sphinx>=5", ] [[project.authors]] From 1b26bd0fd36c296f00a2467d6ed379b19cd1b620 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:12:40 +0000 Subject: [PATCH 4/4] Apply suggestions from code review --- CHANGES | 4 +++- pyproject.toml | 1 + 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 8a2c508..48c08f4 100644 --- a/CHANGES +++ b/CHANGES @@ -1,7 +1,9 @@ Release 1.1.10 (unreleased) =========================== -* Fix circular dependency with Sphinx that caused failure in DAG-based package management +* 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.1.9 (2023-08-20) ========================== diff --git a/pyproject.toml b/pyproject.toml index 68b81a5..7f88862 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,6 +40,7 @@ classifiers = [ "Topic :: Text Processing", "Topic :: Utilities", ] +dependencies = [] dynamic = ["version"] [project.optional-dependencies]