From 777c3a5d41cc81569410bbb6eab3d355c0fc155c Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Thu, 24 Aug 2023 16:03:00 +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 11ea3c2..af56476 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,6 +50,9 @@ lint = [ "mypy", "docutils-stubs", ] +standalone = [ + "sphinx > 5", +] [[project.authors]] name = "Georg Brandl" From c9e11a02a57e80aaf819cf4ed81b77d23920df20 Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Fri, 1 Sep 2023 11:23:03 +0100 Subject: [PATCH 2/4] updates Signed-off-by: Ryan Northey --- .github/workflows/test.yml | 3 +-- CHANGES | 5 +++++ sphinxcontrib/devhelp/__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 e3b3ad7..89d4a46 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,8 @@ +Release 1.0.5 (Pending) +========================== + +* Fix circular dependency with Sphinx that caused failure in DAG-based package management + Release 1.0.4 (2023-08-09) ========================== diff --git a/sphinxcontrib/devhelp/__init__.py b/sphinxcontrib/devhelp/__init__.py index 6f62290..764b953 100644 --- a/sphinxcontrib/devhelp/__init__.py +++ b/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')) From 6074ad3a2b8ab34ff66a05096e450e9a9657815a Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:06:01 +0000 Subject: [PATCH 3/4] Apply suggestions from code review --- CHANGES | 2 +- pyproject.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGES b/CHANGES index 89d4a46..e0ffc17 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,4 @@ -Release 1.0.5 (Pending) +Release 1.0.5 (unreleased) ========================== * Fix circular dependency with Sphinx that caused failure in DAG-based package management diff --git a/pyproject.toml b/pyproject.toml index af56476..3130c72 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -51,7 +51,7 @@ lint = [ "docutils-stubs", ] standalone = [ - "sphinx > 5", + "Sphinx>=5", ] [[project.authors]] From b6ff9615aaa0ffb37a5cd84be00ea16a5ac19c9e Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:11:53 +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 e0ffc17..770d51d 100644 --- a/CHANGES +++ b/CHANGES @@ -1,7 +1,9 @@ Release 1.0.5 (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.4 (2023-08-09) ========================== diff --git a/pyproject.toml b/pyproject.toml index 3130c72..f8492ca 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,7 @@ classifiers = [ "Topic :: Text Processing", "Topic :: Utilities", ] +dependencies = [] dynamic = ["version"] [project.optional-dependencies]