From 719cc977190c2c15c0d94f06f080f5d042a7d976 Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Thu, 24 Aug 2023 16:01:29 +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 d704e4e..03a7a77 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] @@ -54,6 +51,9 @@ lint = [ "mypy", "docutils-stubs", ] +standalone = [ + "sphinx > 5", +] [[project.authors]] name = "Georg Brandl" From bbf7c4ff25c04f2d770a5f4ef34b70ecf38b967c Mon Sep 17 00:00:00 2001 From: Ryan Northey Date: Fri, 1 Sep 2023 11:23:32 +0100 Subject: [PATCH 2/4] updates Signed-off-by: Ryan Northey --- .github/workflows/test.yml | 3 +-- CHANGES | 5 +++++ sphinxcontrib/htmlhelp/__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 2d79803..06ce5bb 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,8 @@ +Release 2.0.4 (Pending) +========================== + +* Fix circular dependency with Sphinx that caused failure in DAG-based package management + Release 2.0.3 (2023-08-09) ========================== diff --git a/sphinxcontrib/htmlhelp/__init__.py b/sphinxcontrib/htmlhelp/__init__.py index de2b776..2c187e5 100644 --- a/sphinxcontrib/htmlhelp/__init__.py +++ b/sphinxcontrib/htmlhelp/__init__.py @@ -296,6 +296,7 @@ def default_htmlhelp_basename(config: Config) -> str: def setup(app: Sphinx) -> dict[str, Any]: + app.require_sphinx('5.0') app.setup_extension('sphinx.builders.html') app.add_builder(HTMLHelpBuilder) app.add_message_catalog(__name__, path.join(package_dir, 'locales')) From d35a05cf05e549edec47274906127976e22ee303 Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:06:10 +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 06ce5bb..cfdd714 100644 --- a/CHANGES +++ b/CHANGES @@ -1,4 +1,4 @@ -Release 2.0.4 (Pending) +Release 2.0.4 (unreleased) ========================== * Fix circular dependency with Sphinx that caused failure in DAG-based package management diff --git a/pyproject.toml b/pyproject.toml index 03a7a77..cb40db0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -52,7 +52,7 @@ lint = [ "docutils-stubs", ] standalone = [ - "sphinx > 5", + "Sphinx>=5", ] [[project.authors]] From 5b6e30ca80c1c1fb4e63586b23651a6166534fac Mon Sep 17 00:00:00 2001 From: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Date: Sat, 13 Jan 2024 02:12:11 +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 cfdd714..0103cb2 100644 --- a/CHANGES +++ b/CHANGES @@ -1,7 +1,9 @@ Release 2.0.4 (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 2.0.3 (2023-08-09) ========================== diff --git a/pyproject.toml b/pyproject.toml index cb40db0..fb933af 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -39,6 +39,7 @@ classifiers = [ "Topic :: Text Processing", "Topic :: Utilities", ] +dependencies = [] dynamic = ["version"] [project.optional-dependencies]