Revert "Move docs/requirements.* to requirements/docs.*"

This reverts commit adf2a99.
jazzband · Aug 21, 2023 · f5ea263 · f5ea263
1 parent a488035
commit f5ea263
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 18 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -23,7 +23,7 @@ build:
 
 python:
   install:
-    - requirements: requirements/docs.txt
+    - requirements: docs/requirements.txt
     - method: pip
       path: .
   system_packages: false
diff --git a/requirements/docs.in → docs/requirements.in b/requirements/docs.in → docs/requirements.in
diff --git a/requirements/docs.txt → docs/requirements.txt b/requirements/docs.txt → docs/requirements.txt
@@ -2,7 +2,7 @@
 # This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    pip-compile --allow-unsafe --strip-extras requirements/docs.in
+#    pip-compile --allow-unsafe --strip-extras docs/requirements.in
 #
 alabaster==0.7.13
     # via sphinx
@@ -19,7 +19,7 @@ docutils==0.20.1
     #   myst-parser
     #   sphinx
 furo==2023.8.17
-    # via -r requirements/docs.in
+    # via -r docs/requirements.in
 idna==3.4
     # via requests
 imagesize==1.4.1
@@ -39,7 +39,7 @@ mdit-py-plugins==0.4.0
 mdurl==0.1.2
     # via markdown-it-py
 myst-parser==2.0.0
-    # via -r requirements/docs.in
+    # via -r docs/requirements.in
 packaging==23.1
     # via
     #   setuptools-scm
@@ -53,14 +53,14 @@ pyyaml==6.0.1
 requests==2.31.0
     # via sphinx
 setuptools-scm==7.1.0
-    # via -r requirements/docs.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/docs.in
+    #   -r docs/requirements.in
     #   furo
     #   myst-parser
     #   sphinx-basic-ng
@@ -81,7 +81,7 @@ sphinxcontrib-htmlhelp==2.0.4
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
 sphinxcontrib-programoutput==0.17
-    # via -r requirements/docs.in
+    # via -r docs/requirements.in
 sphinxcontrib-qthelp==1.0.6
     # via sphinx
 sphinxcontrib-serializinghtml==1.1.8

diff --git a/tox.ini b/tox.ini
@@ -6,7 +6,6 @@ envlist =
     pip{previous,latest,main}
     checkqa
     readme
-    deps
 skip_missing_interpreters = True
 
 [testenv]
@@ -51,20 +50,19 @@ commands =
     twine check --strict {envtmpdir}{/}*
 skip_install = true
 
-[testenv:deps]
-description = compile docs requirements
+[testenv:pip-compile-docs]
+description = compile requirements for the documentation
 commands_pre =
-commands =
-    python -m piptools compile --strip-extras --allow-unsafe --quiet requirements/docs.in {posargs}
+commands = python -m piptools compile --strip-extras --allow-unsafe --quiet docs/requirements.in {posargs}
 
 [testenv:build-docs]
 description = build the documentation
 deps =
-  -r{toxinidir}/requirements/docs.txt
+  -r{toxinidir}/docs/requirements.txt
   # FIXME: re-enable the "-r" + "-c" paradigm once the pip bug is fixed.
   # Ref: https://github.com/pypa/pip/issues/9243
-  # -r{toxinidir}/requirements/docs.in
-  # -c{toxinidir}/requirements/docs.txt
+  # -r{toxinidir}/docs/requirements.in
+  # -c{toxinidir}/docs/requirements.txt
 commands_pre =
 commands =
   # Retrieve possibly missing commits:
@@ -135,11 +133,11 @@ allowlist_externals = {[testenv:build-docs]allowlist_externals}
 [testenv:linkcheck-docs]
 description = check links in the documentation
 deps =
-  -r{toxinidir}/requirements/docs.txt
+  -r{toxinidir}/docs/requirements.txt
   # FIXME: re-enable the "-r" + "-c" paradigm once the pip bug is fixed.
   # Ref: https://github.com/pypa/pip/issues/9243
-  # -r{toxinidir}/requirements/docs.in
-  # -c{toxinidir}/requirements/docs.txt
+  # -r{toxinidir}/docs/requirements.in
+  # -c{toxinidir}/docs/requirements.txt
 commands_pre =
 commands =
   # Retrieve possibly missing commits: