Skip to content

Commit

Permalink
[stable-2.13] pin doc requirements (ansible#270)
Browse files Browse the repository at this point in the history
  • Loading branch information
oraNod authored Aug 10, 2023
1 parent 1f42390 commit 040e2f1
Show file tree
Hide file tree
Showing 4 changed files with 161 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/docsite/rst/community/documentation_contributions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ Drop the ``--user`` option in the following commands if you use a virtual enviro

.. code-block:: bash
pip install --user -r docs/docsite/requirements.txt # This file installs the unpinned dependency versions.
pip install --user -r tests/requirements.txt # This file installs tested dependency versions.
pip install --user -r tests/requirements.in -c tests/requirements.txt # Installs tested dependency versions.
pip install --user -r tests/requirements.in # Installs the unpinned dependency versions.
.. note::

Expand Down
5 changes: 5 additions & 0 deletions tests/constraints.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Known limitations for indirect/transitive dependencies.
resolvelib < 0.9.0
sphinx == 4.2.0
rstcheck == 3.3.1
antsibull-docs == 1.0.0
11 changes: 11 additions & 0 deletions tests/requirements.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
-c constraints.in # <-- contains known limitations

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 # used by ansible-core
sphinx
sphinx-notfound-page
sphinx-ansible-theme
straight.plugin
rstcheck
antsibull-docs
151 changes: 143 additions & 8 deletions tests/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,143 @@
jinja2
pyyaml
resolvelib < 1.1.0
sphinx == 5.3.0
sphinx-notfound-page
sphinx-ansible-theme
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
antsibull-docs == 2.0.0 # currently approved version
#
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile --allow-unsafe --output-file=requirements.txt --strip-extras requirements.in
#
aiofiles==23.2.0
# via antsibull-core
aiohttp==3.8.5
# via antsibull-core
aiosignal==1.3.1
# via aiohttp
alabaster==0.7.13
# via sphinx
ansible-pygments==0.1.1
# via
# antsibull-docs
# sphinx-ansible-theme
antsibull-core==1.6.0
# via antsibull-docs
antsibull-docs==1.0.0
# via
# -c constraints.in
# -r requirements.in
async-timeout==4.0.2
# via aiohttp
asyncio-pool==0.6.0
# via antsibull-docs
attrs==23.1.0
# via aiohttp
babel==2.12.1
# via sphinx
certifi==2023.7.22
# via requests
charset-normalizer==3.2.0
# via
# aiohttp
# requests
docutils==0.17.1
# via
# antsibull-docs
# rstcheck
# sphinx
# sphinx-rtd-theme
frozenlist==1.4.0
# via
# aiohttp
# aiosignal
idna==3.4
# via
# requests
# yarl
imagesize==1.4.1
# via sphinx
jinja2==3.0.3
# via
# -r requirements.in
# antsibull-docs
# sphinx
markupsafe==2.1.3
# via jinja2
multidict==6.0.4
# via
# aiohttp
# yarl
packaging==23.1
# via
# antsibull-core
# sphinx
perky==0.9.2
# via antsibull-core
pydantic==1.10.12
# via antsibull-core
pygments==2.16.1
# via
# ansible-pygments
# sphinx
pyyaml==6.0.1
# via
# -r requirements.in
# antsibull-core
requests==2.31.0
# via sphinx
resolvelib==0.8.1
# via
# -c constraints.in
# -r requirements.in
rstcheck==3.3.1
# via
# -c constraints.in
# -r requirements.in
# antsibull-docs
semantic-version==2.10.0
# via antsibull-core
sh==1.14.3
# via antsibull-core
six==1.16.0
# via twiggy
snowballstemmer==2.2.0
# via sphinx
sphinx==4.2.0
# via
# -c constraints.in
# -r requirements.in
# antsibull-docs
# sphinx-ansible-theme
# sphinx-notfound-page
# sphinx-rtd-theme
# sphinxcontrib-jquery
sphinx-ansible-theme==0.9.1
# via -r requirements.in
sphinx-notfound-page==0.8.3
# via -r requirements.in
sphinx-rtd-theme==1.2.2
# via sphinx-ansible-theme
sphinxcontrib-applehelp==1.0.4
# via sphinx
sphinxcontrib-devhelp==1.0.2
# via sphinx
sphinxcontrib-htmlhelp==2.0.1
# via sphinx
sphinxcontrib-jquery==4.1
# via sphinx-rtd-theme
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.3
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
# via sphinx
straight-plugin==1.5.0
# via -r requirements.in
twiggy==0.5.1
# via antsibull-core
typing-extensions==4.7.1
# via pydantic
urllib3==2.0.4
# via requests
yarl==1.9.2
# via aiohttp

# The following packages are considered to be unsafe in a requirements file:
setuptools==68.0.0
# via sphinx

0 comments on commit 040e2f1

Please sign in to comment.