[stable 2.15] remove the relaxed reqs (#2364)

* rm relaxed reqs and base constraints * move pins and requirements out of relaxed * sync requirements lock file * update noxfile to rm relaxed reqs * update docs * remove tagger session * Update tests/constraints.in Co-authored-by: Felix Fontein <[email protected]> --------- Co-authored-by: Felix Fontein <[email protected]>
ansible · Jan 20, 2025 · 1ce9a2f · 1ce9a2f
1 parent 5c074c4
commit 1ce9a2f
Show file tree

Hide file tree

Showing 8 changed files with 56 additions and 224 deletions.
diff --git a/docs/docsite/rst/community/documentation_contributions.rst b/docs/docsite/rst/community/documentation_contributions.rst
@@ -113,7 +113,6 @@ For more information on minimum Python versions, see the :ref:`support matrix <s
 
     pip install -r tests/requirements.in -c tests/requirements.txt # Installs tested dependency versions.
     pip install -r tests/requirements.in # Installs the unpinned dependency versions.
-    pip install -r tests/requirements-relaxed.in # Installs the unpinned dependency versions including untested antsibull-docs.
 
 
 .. note::

diff --git a/noxfile.py b/noxfile.py
@@ -2,7 +2,6 @@
 
 import os
 import shlex
-from argparse import ArgumentParser, BooleanOptionalAction
 from glob import iglob
 from pathlib import Path
 from typing import cast
@@ -162,20 +161,6 @@ def _clone_core_check(session: nox.Session) -> None:
     session.run("python", "docs/bin/clone-core.py", "--check")
 
 
-def _relaxed_parser(session: nox.Session) -> ArgumentParser:
-    """
-    Generate an argument parser with a --relaxed option.
-    """
-    parser = ArgumentParser(prog=f"nox -e {session.name} --")
-    parser.add_argument(
-        "--relaxed",
-        default=False,
-        action=BooleanOptionalAction,
-        help="Whether to use requirements-relaxed file. (Default: %(default)s)",
-    )
-    return parser
-
-
 def _env_python(session: nox.Session) -> str:
     """
     Get the full path to an environment's python executable
@@ -193,9 +178,8 @@ def checkers(session: nox.Session, test: str):
     """
     Run docs build checkers
     """
-    args = _relaxed_parser(session).parse_args(session.posargs)
 
-    install(session, req="requirements-relaxed" if args.relaxed else "requirements")
+    install(session, req="requirements")
     _clone_core_check(session)
     session.run("make", "-C", "docs/docsite", "clean", external=True)
     session.run("python", "tests/checkers.py", test)
@@ -206,16 +190,15 @@ def make(session: nox.Session):
     """
     Generate HTML from documentation source using the Makefile
     """
-    parser = _relaxed_parser(session)
-    parser.add_argument(
-        "make_args", nargs="*", help="Specify make targets as arguments"
-    )
-    args = parser.parse_args(session.posargs)
+    make_args = session.posargs or ["clean", "coredocs"]
 
-    install(session, req="requirements-relaxed" if args.relaxed else "requirements")
+    install(session, req="requirements")
     _clone_core_check(session)
-    make_args: list[str] = [
+    session.run(
+        "make",
+        "-C",
+        "docs/docsite",
         f"PYTHON={_env_python(session)}",
-        *(args.make_args or ("clean", "coredocs")),
-    ]
-    session.run("make", "-C", "docs/docsite", *make_args, external=True)
+        *make_args,
+        external=True,
+    )
diff --git a/tests/constraints-base.in b/tests/constraints-base.in
diff --git a/tests/constraints.in b/tests/constraints.in
@@ -1,5 +1,12 @@
 # This constraints file contains pins for the stable, tested versions of sphinx
 # and antsibull-docs that production builds rely upon.
+# This constraint file also pins other versions for which there are known limitations.
 
-sphinx == 5.3.0
+sphinx == 5.3.0 # https://github.com/readthedocs/sphinx-notfound-page/issues/219
 antsibull-docs == 2.7.0  # currently approved version
+
+rstcheck < 6  # rstcheck 6.x has problem with rstcheck.core triggered by include files w/ sphinx directives https://github.com/rstcheck/rstcheck-core/issues/3
+jinja2 >= 3.0.0 # https://github.com/ansible/ansible/blob/stable-2.15/requirements.txt
+pyyaml >= 5.1 # https://github.com/ansible/ansible/blob/stable-2.15/requirements.txt
+importlib_resources >= 5.0, < 5.1; python_version < '3.10' # https://github.com/ansible/ansible/blob/stable-2.15/requirements.txt
+resolvelib >= 0.5.3, < 1.1.0 # https://github.com/ansible/ansible/blob/stable-2.15/requirements.txt
diff --git a/tests/requirements-relaxed.in b/tests/requirements-relaxed.in
diff --git a/tests/requirements-relaxed.txt b/tests/requirements-relaxed.txt
diff --git a/tests/requirements.in b/tests/requirements.in
@@ -1,5 +1,15 @@
-# This requirements file is used for stable ansible docs builds
-# It depends on specific, tested antsibull-docs and sphinx versions
+# This requirements file is used for doc builds
 
 -c constraints.in # <-- contains known limitations
--r requirements-relaxed.in # <-- contains base set of dependencies
+
+# Base set of dependencies.
+
+antsibull-docs
+sphinx
+sphinx-intl # translation utility used by docs/docsite/Makefile
+sphinx-notfound-page # extension used for the custom 404 page (cowsay)
+sphinx-ansible-theme # extension used for the custom docs theme
+rstcheck
+jinja2 # used by hacking/build_library/build_ansible/command_plugins/generate_man.py and dump_keywords.py
+pyyaml # used by ansible-core
+resolvelib # used by ansible-core
diff --git a/tests/requirements.txt b/tests/requirements.txt
@@ -25,7 +25,7 @@ antsibull-core==2.1.0
 antsibull-docs==2.7.0
     # via
     #   -c tests/constraints.in
-    #   -r tests/requirements-relaxed.in
+    #   -r tests/requirements.in
 antsibull-docs-parser==1.0.0
     # via antsibull-docs
 async-timeout==4.0.3
@@ -35,13 +35,17 @@ asyncio-pool==0.6.0
 attrs==23.1.0
     # via aiohttp
 babel==2.12.1
-    # via sphinx
+    # via
+    #   sphinx
+    #   sphinx-intl
 build==1.0.3
     # via antsibull-core
 certifi==2023.7.22
     # via requests
 charset-normalizer==3.2.0
     # via requests
+click==8.1.8
+    # via sphinx-intl
 docutils==0.18.1
     # via
     #   antsibull-docs
@@ -60,7 +64,8 @@ imagesize==1.4.1
     # via sphinx
 jinja2==3.1.2
     # via
-    #   -r tests/requirements-relaxed.in
+    #   -c tests/constraints.in
+    #   -r tests/requirements.in
     #   antsibull-docs
     #   sphinx
 markupsafe==2.1.3
@@ -89,17 +94,20 @@ pyproject-hooks==1.0.0
     # via build
 pyyaml==6.0.1
     # via
-    #   -r tests/requirements-relaxed.in
+    #   -c tests/constraints.in
+    #   -r tests/requirements.in
     #   antsibull-core
     #   antsibull-docs
 requests==2.31.0
     # via sphinx
 resolvelib==1.0.1
-    # via -r tests/requirements-relaxed.in
+    # via
+    #   -c tests/constraints.in
+    #   -r tests/requirements.in
 rstcheck==5.0.0
     # via
-    #   -c tests/constraints-base.in
-    #   -r tests/requirements-relaxed.in
+    #   -c tests/constraints.in
+    #   -r tests/requirements.in
     #   antsibull-docs
 semantic-version==2.10.0
     # via
@@ -113,11 +121,11 @@ snowballstemmer==2.2.0
     # via sphinx
 sphinx==5.3.0
     # via
-    #   -c tests/constraints-base.in
     #   -c tests/constraints.in
-    #   -r tests/requirements-relaxed.in
+    #   -r tests/requirements.in
     #   antsibull-docs
     #   sphinx-ansible-theme
+    #   sphinx-intl
     #   sphinx-notfound-page
     #   sphinx-rtd-theme
     #   sphinxcontrib-applehelp
@@ -127,9 +135,11 @@ sphinx==5.3.0
     #   sphinxcontrib-qthelp
     #   sphinxcontrib-serializinghtml
 sphinx-ansible-theme==0.10.2
-    # via -r tests/requirements-relaxed.in
+    # via -r tests/requirements.in
+sphinx-intl==2.3.1
+    # via -r tests/requirements.in
 sphinx-notfound-page==1.0.0
-    # via -r tests/requirements-relaxed.in
+    # via -r tests/requirements.in
 sphinx-rtd-theme==1.3.0
     # via sphinx-ansible-theme
 sphinxcontrib-applehelp==1.0.7
@@ -164,3 +174,7 @@ urllib3==2.0.5
     # via requests
 yarl==1.9.2
     # via aiohttp
+
+# The following packages are considered to be unsafe in a requirements file:
+setuptools==75.8.0
+    # via sphinx-intl