Merge pull request #2219 from sirosen/more-reproducible-docs-builds

Pin pip-tools' dependencies for "build-docs"

Author: webknjaz

docs/requirements.txt

@@ -2,26 +2,30 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    pip-compile --allow-unsafe --strip-extras requirements.in
+#    pip-compile --allow-unsafe --output-file=docs/requirements.txt --strip-extras ./pyproject.toml docs/requirements.in
 #
 alabaster==0.7.13
     # via sphinx
 babel==2.12.1
     # via sphinx
 beautifulsoup4==4.12.2
     # via furo
+build==1.3.0
+    # via pip-tools (pyproject.toml)
 certifi==2024.7.4
     # via requests
 charset-normalizer==3.2.0
     # via requests
 click==8.2.1
-    # via towncrier
+    # via
+    #   pip-tools (pyproject.toml)
+    #   towncrier
 docutils==0.20.1
     # via
     #   myst-parser
     #   sphinx
 furo==2023.8.17
-    # via -r requirements.in
+    # via -r docs/requirements.in
 idna==3.7
     # via requests
 imagesize==1.4.1
@@ -42,9 +46,10 @@ mdit-py-plugins==0.4.0
 mdurl==0.1.2
     # via markdown-it-py
 myst-parser==2.0.0
-    # via -r requirements.in
+    # via -r docs/requirements.in
 packaging==23.1
     # via
+    #   build
     #   setuptools-scm
     #   sphinx
 pbr==6.0.0
@@ -53,19 +58,23 @@ pygments==2.16.1
     # via
     #   furo
     #   sphinx
+pyproject-hooks==1.2.0
+    # via
+    #   build
+    #   pip-tools (pyproject.toml)
 pyyaml==6.0.1
     # via myst-parser
 requests==2.32.4
     # via sphinx
 setuptools-scm==7.1.0
-    # via -r requirements.in
+    # via -r docs/requirements.in
 snowballstemmer==2.2.0
     # via sphinx
 soupsieve==2.4.1
     # via beautifulsoup4
 sphinx==7.2.2
     # via
-    #   -r requirements.in
+    #   -r docs/requirements.in
     #   furo
     #   myst-parser
     #   sphinx-basic-ng
@@ -81,9 +90,9 @@ sphinx==7.2.2
 sphinx-basic-ng==1.0.0b2
     # via furo
 sphinx-issues==5.0.1
-    # via -r requirements.in
+    # via -r docs/requirements.in
 sphinxcontrib-apidoc==0.5.0
-    # via -r requirements.in
+    # via -r docs/requirements.in
 sphinxcontrib-applehelp==1.0.7
     # via sphinx
 sphinxcontrib-devhelp==1.0.5
@@ -93,20 +102,26 @@ sphinxcontrib-htmlhelp==2.0.4
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
 sphinxcontrib-programoutput==0.17
-    # via -r requirements.in
+    # via -r docs/requirements.in
 sphinxcontrib-qthelp==1.0.6
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.8
     # via sphinx
 sphinxcontrib-towncrier==0.5.0a0
-    # via -r requirements.in
+    # via -r docs/requirements.in
 towncrier==24.8.0
     # via sphinxcontrib-towncrier
 typing-extensions==4.7.1
     # via setuptools-scm
 urllib3==2.5.0
     # via requests
+wheel==0.45.1
+    # via pip-tools (pyproject.toml)
 
 # The following packages are considered to be unsafe in a requirements file:
+pip==25.1
+    # via pip-tools (pyproject.toml)
 setuptools==78.1.1
-    # via setuptools-scm
+    # via
+    #   pip-tools (pyproject.toml)
+    #   setuptools-scm

tox.ini

@@ -58,9 +58,19 @@ skip_install = true
 
 [testenv:pip-compile-docs]
 description = compile requirements for the documentation
-changedir = {[testenv:build-docs]changedir}
 commands_pre =
-commands = python -m piptools compile --strip-extras --allow-unsafe --quiet requirements.in {posargs}
+# compile requirements.in + pyproject.toml to get pip-tools install requirements in
+# addition to doc tooling requirements *but without* putting `pip-tools` itself
+# into the output
+commands =
+  python -m piptools compile \
+    --strip-extras \
+    --allow-unsafe \
+    --quiet \
+    docs/requirements.in \
+    './pyproject.toml' \
+    -o docs/requirements.txt \
+    {posargs}
 
 [testenv:build-docs]
 description = build the documentation