From 32d5a29a8572ae2014a87bb55f39650c5c37d91d Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Thu, 24 Aug 2023 16:00:31 +0100 Subject: [PATCH 1/6] deps: Make Sphinx optional Signed-off-by: Ryan Northey --- .github/workflows/test.yml | 1 + pyproject.toml | 7 +++---- 2 files changed, 4 insertions(+), 4 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 a8cbb00..4a5013d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,9 +39,6 @@ classifiers = [ "Topic :: Text Processing", "Topic :: Utilities", ] -dependencies = [ - "Sphinx>=5", -] dynamic = ["version"] [project.optional-dependencies] @@ -53,7 +50,9 @@ lint = [ "mypy", "docutils-stubs", ] - +standalone = [ + "sphinx > 5", +] [[project.authors]] name = "Georg Brandl" email = "georg@python.org" From b8dc42f4a013d449d89b3876e81844835883ac52 Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Fri, 1 Sep 2023 11:22:51 +0100 Subject: [PATCH 2/6] updates Signed-off-by: Ryan Northey --- .github/workflows/test.yml | 3 +-- CHANGES | 5 +++++ sphinxcontrib/applehelp/__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 f3cc01c..c88f589 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,8 @@ +Release 1.0.7 (Pending) +========================== + +* Fix circular dependency with Sphinx that caused failure in DAG-based package management + Release 1.0.6 (2023-08-09) ========================== diff --git a/sphinxcontrib/applehelp/__init__.py b/sphinxcontrib/applehelp/__init__.py index 476a976..30f154f 100644 --- a/sphinxcontrib/applehelp/__init__.py +++ b/sphinxcontrib/applehelp/__init__.py @@ -227,6 +227,7 @@ def do_codesign(self) -> None: def setup(app: Sphinx) -> dict[str, Any]: + app.require_sphinx('5.0') app.setup_extension('sphinx.builders.html') app.add_builder(AppleHelpBuilder) app.add_message_catalog(__name__, path.join(package_dir, 'locales')) From 4cda70d7862f3e4bc016f21d4b4c77425f9018f6 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:02:43 +0000 Subject: [PATCH 3/6] Apply suggestions from code review --- CHANGES | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index c88f589..c2d8cf9 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,4 @@ -Release 1.0.7 (Pending) +Release 1.0.7 (unreleased) ========================== * Fix circular dependency with Sphinx that caused failure in DAG-based package management diff --git a/pyproject.toml b/pyproject.toml index 4a5013d..de694cd 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -51,7 +51,7 @@ lint = [ "docutils-stubs", ] standalone = [ - "sphinx > 5", + "Sphinx>=5", ] [[project.authors]] name = "Georg Brandl" From 6b629a68875dac796ef11a389670cadadc08f837 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:09:42 +0000 Subject: [PATCH 4/6] Apply suggestions from code review --- CHANGES | 4 +++- pyproject.toml | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index c2d8cf9..4f52930 100644 --- a/CHANGES +++ b/CHANGES @@ -1,7 +1,9 @@ Release 1.0.7 (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.0.6 (2023-08-09) ========================== diff --git a/pyproject.toml b/pyproject.toml index de694cd..2a68f6d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -51,7 +51,7 @@ lint = [ "docutils-stubs", ] standalone = [ - "Sphinx>=5", + "Sphinx>=5", ] [[project.authors]] name = "Georg Brandl" From da82ee4f302a4a1e6132683a87c0b0247cdc054a Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:11:39 +0000 Subject: [PATCH 5/6] Update pyproject.toml --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 2a68f6d..06ef5c1 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,7 @@ classifiers = [ "Topic :: Text Processing", "Topic :: Utilities", ] +dependencies = [] dynamic = ["version"] [project.optional-dependencies] From 4f847b26824ba1f2a5874c6b53d627be17ca225c Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:13:48 +0000 Subject: [PATCH 6/6] Update pyproject.toml --- pyproject.toml | 1 + 1 file changed, 1 insertion(+) diff --git a/pyproject.toml b/pyproject.toml index 06ef5c1..eef6260 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -54,6 +54,7 @@ lint = [ standalone = [ "Sphinx>=5", ] + [[project.authors]] name = "Georg Brandl" email = "georg@python.org"