centersl/ansible-docs
1
0
Fork 0
mirror of https://github.com/ansible/ansible-documentation.git synced 2026-03-26 13:18:58 +07:00
Code Issues Packages Projects Releases Wiki Activity

[stable 2.16] remove the relaxed reqs (#2363)

Browse Source 
* 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
This commit is contained in:
Don Naro
2025-01-20 17:42:44 +00:00
committed by GitHub
parent 00194270ee
commit cb0a8f6dc6
8 changed files with 46 additions and 258 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/docsite/rst/community/documentation_contributions.rst
View File

@@ -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::

37
noxfile.py
View File

@@ -2,7 +2,6 @@ from __future__ import annotations
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,
)

4
tests/constraints-base.in
View File

@@ -1,4 +0,0 @@
# Known limitations for indirect/transitive dependencies.
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
sphinx < 7.2 # sphinx >= 7.2 breaks for 404 pages. -- https://github.com/ansible/ansible-documentation/issues/678

8
tests/constraints.in
View File

@@ -1,5 +1,11 @@
# 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 == 7.1.2
sphinx == 7.1.2 # sphinx >= 7.2 breaks for 404 pages. -- https://github.com/ansible/ansible-documentation/issues/678
antsibull-docs == 2.16.2 # 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.16/requirements.txt
pyyaml >= 5.1 # https://github.com/ansible/ansible/blob/stable-2.16/requirements.txt
resolvelib >= 0.5.3, < 1.1.0 # https://github.com/ansible/ansible/blob/stable-2.16/requirements.txt

16
tests/requirements-relaxed.in
View File

@@ -1,16 +0,0 @@
# This requirements file contains no pins on antsibull-docs and other
# essential tools
# It's used for testing purposes and devel branch builds on docs.ansible.com.
-c constraints-base.in
jinja2 >= 3.0.0 # used by hacking/build_library/build_ansible/command_plugins/generate_man.py and dump_keywords.py
pyyaml >= 5.1 # used by ansible-core
resolvelib >= 0.5.3, < 1.1.0 # used by ansible-core
sphinx
sphinx-intl # translation utility used by docs/docsite/Makefile
sphinx-notfound-page
sphinx-ansible-theme
rstcheck
antsibull-docs ~= 2.0
sphinx-copybutton

194
tests/requirements-relaxed.txt
View File

@@ -1,194 +0,0 @@
#
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile --allow-unsafe --output-file=tests/requirements-relaxed.txt --strip-extras tests/requirements-relaxed.in
#
aiofiles==24.1.0
# via
# antsibull-core
# antsibull-fileutils
aiohappyeyeballs==2.4.3
# via aiohttp
aiohttp==3.11.7
# via
# antsibull-core
# antsibull-docs
aiosignal==1.3.1
# via aiohttp
alabaster==0.7.16
# via sphinx
annotated-types==0.7.0
# via pydantic
ansible-pygments==0.1.1
# via
# antsibull-docs
# sphinx-ansible-theme
antsibull-changelog==0.31.1
# via antsibull-docs
antsibull-core==3.4.0
# via antsibull-docs
antsibull-docs==2.16.2
# via -r tests/requirements-relaxed.in
antsibull-docs-parser==1.1.0
# via antsibull-docs
antsibull-docutils==1.0.0
# via antsibull-changelog
antsibull-fileutils==1.1.0
# via
# antsibull-changelog
# antsibull-core
# antsibull-docs
async-timeout==5.0.1
# via aiohttp
asyncio-pool==0.6.0
# via antsibull-docs
attrs==24.2.0
# via aiohttp
babel==2.16.0
# via
# sphinx
# sphinx-intl
build==1.2.2.post1
# via antsibull-core
certifi==2024.8.30
# via requests
charset-normalizer==3.4.0
# via requests
click==8.1.7
# via sphinx-intl
docutils==0.18.1
# via
# antsibull-changelog
# antsibull-docs
# antsibull-docutils
# rstcheck
# sphinx
# sphinx-rtd-theme
frozenlist==1.5.0
# via
# aiohttp
# aiosignal
idna==3.10
# via
# requests
# yarl
imagesize==1.4.1
# via sphinx
jinja2==3.1.4
# via
# -r tests/requirements-relaxed.in
# antsibull-docs
# sphinx
markupsafe==3.0.2
# via jinja2
multidict==6.1.0
# via
# aiohttp
# yarl
packaging==24.2
# via
# antsibull-changelog
# antsibull-core
# antsibull-docs
# build
# sphinx
perky==0.9.3
# via antsibull-core
propcache==0.2.0
# via
# aiohttp
# yarl
pydantic==2.10.0
# via
# antsibull-core
# antsibull-docs
pydantic-core==2.27.0
# via pydantic
pygments==2.18.0
# via
# ansible-pygments
# sphinx
pyproject-hooks==1.2.0
# via build
pyyaml==6.0.2
# via
# -r tests/requirements-relaxed.in
# antsibull-docs
# antsibull-fileutils
requests==2.32.3
# via sphinx
resolvelib==1.0.1
# via -r tests/requirements-relaxed.in
rstcheck==5.0.0
# via
# -c tests/constraints-base.in
# -r tests/requirements-relaxed.in
# antsibull-changelog
# antsibull-docs
semantic-version==2.10.0
# via
# antsibull-changelog
# antsibull-core
# antsibull-docs
six==1.16.0
# via twiggy
snowballstemmer==2.2.0
# via sphinx
sphinx==7.1.2
# via
# -c tests/constraints-base.in
# -r tests/requirements-relaxed.in
# antsibull-docs
# sphinx-ansible-theme
# sphinx-copybutton
# sphinx-intl
# sphinx-notfound-page
# sphinx-rtd-theme
# sphinxcontrib-jquery
sphinx-ansible-theme==0.10.3
# via -r tests/requirements-relaxed.in
sphinx-copybutton==0.5.2
# via -r tests/requirements-relaxed.in
sphinx-intl==2.3.0
# via -r tests/requirements-relaxed.in
sphinx-notfound-page==1.0.4
# via -r tests/requirements-relaxed.in
sphinx-rtd-theme==3.0.2
# via sphinx-ansible-theme
sphinxcontrib-applehelp==2.0.0
# via sphinx
sphinxcontrib-devhelp==2.0.0
# via sphinx
sphinxcontrib-htmlhelp==2.1.0
# via sphinx
sphinxcontrib-jquery==4.1
# via sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
tomli==2.1.0
# via build
twiggy==0.5.1
# via
# antsibull-core
# antsibull-docs
types-docutils==0.18.3
# via rstcheck
typing-extensions==4.12.2
# via
# multidict
# pydantic
# pydantic-core
# rstcheck
urllib3==2.2.3
# via requests
yarl==1.18.0
# via aiohttp
# The following packages are considered to be unsafe in a requirements file:
setuptools==75.6.0
# via sphinx-intl

17
tests/requirements.in
View File

@@ -1,5 +1,16 @@
# 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
sphinx-copybutton
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

27
tests/requirements.txt
View File

@@ -31,7 +31,7 @@ antsibull-core==3.4.0
antsibull-docs==2.16.2
# via
# -c tests/constraints.in
# -r tests/requirements-relaxed.in
# -r tests/requirements.in
antsibull-docs-parser==1.1.0
# via antsibull-docs
antsibull-docutils==1.0.0
@@ -79,7 +79,8 @@ imagesize==1.4.1
# via sphinx
jinja2==3.1.4
# via
# -r tests/requirements-relaxed.in
# -c tests/constraints.in
# -r tests/requirements.in
# antsibull-docs
# sphinx
markupsafe==3.0.2
@@ -115,17 +116,20 @@ pyproject-hooks==1.2.0
# via build
pyyaml==6.0.2
# via
# -r tests/requirements-relaxed.in
# -c tests/constraints.in
# -r tests/requirements.in
# antsibull-docs
# antsibull-fileutils
requests==2.32.3
# 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-changelog
# antsibull-docs
semantic-version==2.10.0
@@ -139,9 +143,8 @@ snowballstemmer==2.2.0
# via sphinx
sphinx==7.1.2
# 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-copybutton
@@ -150,13 +153,13 @@ sphinx==7.1.2
# sphinx-rtd-theme
# sphinxcontrib-jquery
sphinx-ansible-theme==0.10.3
# via -r tests/requirements-relaxed.in
# via -r tests/requirements.in
sphinx-copybutton==0.5.2
# via -r tests/requirements-relaxed.in
# via -r tests/requirements.in
sphinx-intl==2.3.0
# via -r tests/requirements-relaxed.in
# via -r tests/requirements.in
sphinx-notfound-page==1.0.4
# via -r tests/requirements-relaxed.in
# via -r tests/requirements.in
sphinx-rtd-theme==3.0.2
# via sphinx-ansible-theme
sphinxcontrib-applehelp==2.0.0