Hotfix for sphinx-init's generated requirements (#149)

* Hotfix for sphinx-init's generated requirements. * Improve changelog formulation. Co-authored-by: Maxwell G <maxwell@gtmx.me> --------- Co-authored-by: Maxwell G <maxwell@gtmx.me>
ansible-community · May 10, 2023 · 1967a3d · 1967a3d
1 parent 0cdf4e4
commit 1967a3d
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 6 deletions.
diff --git a/changelogs/fragments/2.0.0a2.yml b/changelogs/fragments/2.0.0a2.yml
@@ -0,0 +1,3 @@
+release_summary: Hotfix to make ``sphinx-init`` work properly.
+bugfixes:
+  - "Bump version range of antsibull-docs requirement written by ``sphinx-init`` subcommand to ``>= 2.0.0a2, < 3.0.0``. Previously, this was set to ``>=2.0.0, <3.0.0`` which could not be satisfied (https://github.com/ansible-community/antsibull-docs/pull/149)."
diff --git a/pyproject.toml b/pyproject.toml
@@ -8,7 +8,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "antsibull-docs"
-version = "2.0.0a1.post0"
+version = "2.0.0a2"
 description = "Tools for building Ansible documentation"
 license = "GPL-3.0-or-later"
 license-files = {globs=["LICENSES/*.txt"]}

diff --git a/src/antsibull_docs/data/sphinx_init/requirements_txt.j2 b/src/antsibull_docs/data/sphinx_init/requirements_txt.j2
@@ -2,7 +2,7 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-antsibull-docs >= 2.0.0, < 3.0.0
+antsibull-docs >= 2.0.0a2, < 3.0.0
 ansible-pygments
 sphinx
 @{ sphinx_theme_package }@
diff --git a/tests/functional/baseline-sphinx-init-collections/requirements.txt b/tests/functional/baseline-sphinx-init-collections/requirements.txt
@@ -2,7 +2,7 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-antsibull-docs >= 2.0.0, < 3.0.0
+antsibull-docs >= 2.0.0a2, < 3.0.0
 ansible-pygments
 sphinx
 sphinx-ansible-theme >= 0.9.0
diff --git a/tests/functional/baseline-sphinx-init-config/requirements.txt b/tests/functional/baseline-sphinx-init-config/requirements.txt
@@ -2,7 +2,7 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-antsibull-docs >= 2.0.0, < 3.0.0
+antsibull-docs >= 2.0.0a2, < 3.0.0
 ansible-pygments
 sphinx
 another-theme
diff --git a/tests/functional/baseline-sphinx-init-current/requirements.txt b/tests/functional/baseline-sphinx-init-current/requirements.txt
@@ -2,7 +2,7 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-antsibull-docs >= 2.0.0, < 3.0.0
+antsibull-docs >= 2.0.0a2, < 3.0.0
 ansible-pygments
 sphinx
 sphinx-ansible-theme >= 0.9.0
diff --git a/tests/functional/baseline-sphinx-init-extra/requirements.txt b/tests/functional/baseline-sphinx-init-extra/requirements.txt
@@ -2,7 +2,7 @@
 # GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
 # SPDX-License-Identifier: GPL-3.0-or-later
 
-antsibull-docs >= 2.0.0, < 3.0.0
+antsibull-docs >= 2.0.0a2, < 3.0.0
 ansible-pygments
 sphinx
 sphinx-ansible-theme >= 0.9.0