From b00a07510beeb63a0bb19051d2fe56c44c7be09a Mon Sep 17 00:00:00 2001 From: Albert Tugushev Date: Fri, 18 Aug 2023 20:11:32 +0200 Subject: [PATCH 1/4] Upgrade Sphinx --- docs/requirements.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/requirements.txt b/docs/requirements.txt index 87ab6b6de..3c2152915 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,5 @@ furo >= 2021.7.5b38 myst-parser >= 0.15.1 setuptools-scm >= 6.0.1 -Sphinx >= 4.1.1 +Sphinx >= 7.2.2 sphinxcontrib-programoutput >= 0.17 From 7234b096484b4eb27cfe344bb5f79794d4000f5f Mon Sep 17 00:00:00 2001 From: Albert Tugushev Date: Fri, 18 Aug 2023 20:42:14 +0200 Subject: [PATCH 2/4] Add a tox env to compile requirements for the docs --- docs/requirements.in | 5 +++ docs/requirements.txt | 101 +++++++++++++++++++++++++++++++++++++++--- tox.ini | 5 +++ 3 files changed, 106 insertions(+), 5 deletions(-) create mode 100644 docs/requirements.in diff --git a/docs/requirements.in b/docs/requirements.in new file mode 100644 index 000000000..fdee13392 --- /dev/null +++ b/docs/requirements.in @@ -0,0 +1,5 @@ +furo +myst-parser +setuptools-scm +sphinx +sphinxcontrib-programoutput diff --git a/docs/requirements.txt b/docs/requirements.txt index 3c2152915..4eb1d273e 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,5 +1,96 @@ -furo >= 2021.7.5b38 -myst-parser >= 0.15.1 -setuptools-scm >= 6.0.1 -Sphinx >= 7.2.2 -sphinxcontrib-programoutput >= 0.17 +# +# This file is autogenerated by pip-compile with Python 3.11 +# by the following command: +# +# pip-compile --allow-unsafe --strip-extras docs/requirements.in +# +alabaster==0.7.13 + # via sphinx +babel==2.12.1 + # via sphinx +beautifulsoup4==4.12.2 + # via furo +certifi==2023.7.22 + # via requests +charset-normalizer==3.2.0 + # via requests +docutils==0.20.1 + # via + # myst-parser + # sphinx +furo==2023.8.17 + # via -r docs/requirements.in +idna==3.4 + # via requests +imagesize==1.4.1 + # via sphinx +jinja2==3.1.2 + # via + # myst-parser + # sphinx +markdown-it-py==3.0.0 + # via + # mdit-py-plugins + # myst-parser +markupsafe==2.1.3 + # via jinja2 +mdit-py-plugins==0.4.0 + # via myst-parser +mdurl==0.1.2 + # via markdown-it-py +myst-parser==2.0.0 + # via -r docs/requirements.in +packaging==23.1 + # via + # setuptools-scm + # sphinx +pygments==2.16.1 + # via + # furo + # sphinx +pyyaml==6.0.1 + # via myst-parser +requests==2.31.0 + # via sphinx +setuptools-scm==7.1.0 + # via -r docs/requirements.in +snowballstemmer==2.2.0 + # via sphinx +soupsieve==2.4.1 + # via beautifulsoup4 +sphinx==7.2.2 + # via + # -r docs/requirements.in + # furo + # myst-parser + # sphinx-basic-ng + # sphinxcontrib-applehelp + # sphinxcontrib-devhelp + # sphinxcontrib-htmlhelp + # sphinxcontrib-programoutput + # sphinxcontrib-qthelp + # sphinxcontrib-serializinghtml +sphinx-basic-ng==1.0.0b2 + # via furo +sphinxcontrib-applehelp==1.0.7 + # via sphinx +sphinxcontrib-devhelp==1.0.5 + # via sphinx +sphinxcontrib-htmlhelp==2.0.4 + # via sphinx +sphinxcontrib-jsmath==1.0.1 + # via sphinx +sphinxcontrib-programoutput==0.17 + # via -r docs/requirements.in +sphinxcontrib-qthelp==1.0.6 + # via sphinx +sphinxcontrib-serializinghtml==1.1.8 + # via sphinx +typing-extensions==4.7.1 + # via setuptools-scm +urllib3==2.0.4 + # via requests + +# The following packages are considered to be unsafe in a requirements file: +setuptools==68.1.2 + # via setuptools-scm diff --git a/tox.ini b/tox.ini index 473826776..5ded61bbe 100644 --- a/tox.ini +++ b/tox.ini @@ -50,6 +50,11 @@ commands = twine check --strict {envtmpdir}{/}* skip_install = true +[testenv:pip-compile-docs] +description = compile requirements for the documentation +commands_pre = +commands = python -m piptools compile --strip-extras --allow-unsafe --quiet docs/requirements.in {posargs} + [testenv:build-docs] description = build the documentation deps = From a488035398b3a050b70b00809061860b72a94a3e Mon Sep 17 00:00:00 2001 From: Albert Tugushev Date: Fri, 18 Aug 2023 21:38:14 +0200 Subject: [PATCH 3/4] Move docs/requirements.* to requirements/docs.* This step prepares for the removal of the testing extra from pyproject.toml and transitioning towards using requirements/tests.{in,txt}. --- .readthedocs.yaml | 2 +- docs/requirements.in => requirements/docs.in | 0 .../requirements.txt => requirements/docs.txt | 12 +++++------ tox.ini | 20 ++++++++++--------- 4 files changed, 18 insertions(+), 16 deletions(-) rename docs/requirements.in => requirements/docs.in (100%) rename docs/requirements.txt => requirements/docs.txt (88%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index e4ddb28a9..bb2363383 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -23,7 +23,7 @@ build: python: install: - - requirements: docs/requirements.txt + - requirements: requirements/docs.txt - method: pip path: . system_packages: false diff --git a/docs/requirements.in b/requirements/docs.in similarity index 100% rename from docs/requirements.in rename to requirements/docs.in diff --git a/docs/requirements.txt b/requirements/docs.txt similarity index 88% rename from docs/requirements.txt rename to requirements/docs.txt index 4eb1d273e..4e5343180 100644 --- a/docs/requirements.txt +++ b/requirements/docs.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 docs/requirements.in +# pip-compile --allow-unsafe --strip-extras requirements/docs.in # alabaster==0.7.13 # via sphinx @@ -19,7 +19,7 @@ docutils==0.20.1 # myst-parser # sphinx furo==2023.8.17 - # via -r docs/requirements.in + # via -r requirements/docs.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 docs/requirements.in + # via -r requirements/docs.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 docs/requirements.in + # via -r requirements/docs.in snowballstemmer==2.2.0 # via sphinx soupsieve==2.4.1 # via beautifulsoup4 sphinx==7.2.2 # via - # -r docs/requirements.in + # -r requirements/docs.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 docs/requirements.in + # via -r requirements/docs.in sphinxcontrib-qthelp==1.0.6 # via sphinx sphinxcontrib-serializinghtml==1.1.8 diff --git a/tox.ini b/tox.ini index 5ded61bbe..5c67e3594 100644 --- a/tox.ini +++ b/tox.ini @@ -6,6 +6,7 @@ envlist = pip{previous,latest,main} checkqa readme + deps skip_missing_interpreters = True [testenv] @@ -50,19 +51,20 @@ commands = twine check --strict {envtmpdir}{/}* skip_install = true -[testenv:pip-compile-docs] -description = compile requirements for the documentation +[testenv:deps] +description = compile docs requirements commands_pre = -commands = python -m piptools compile --strip-extras --allow-unsafe --quiet docs/requirements.in {posargs} +commands = + python -m piptools compile --strip-extras --allow-unsafe --quiet requirements/docs.in {posargs} [testenv:build-docs] description = build the documentation deps = - -r{toxinidir}/docs/requirements.txt + -r{toxinidir}/requirements/docs.txt # FIXME: re-enable the "-r" + "-c" paradigm once the pip bug is fixed. # Ref: https://github.com/pypa/pip/issues/9243 - # -r{toxinidir}/docs/requirements.in - # -c{toxinidir}/docs/requirements.txt + # -r{toxinidir}/requirements/docs.in + # -c{toxinidir}/requirements/docs.txt commands_pre = commands = # Retrieve possibly missing commits: @@ -133,11 +135,11 @@ allowlist_externals = {[testenv:build-docs]allowlist_externals} [testenv:linkcheck-docs] description = check links in the documentation deps = - -r{toxinidir}/docs/requirements.txt + -r{toxinidir}/requirements/docs.txt # FIXME: re-enable the "-r" + "-c" paradigm once the pip bug is fixed. # Ref: https://github.com/pypa/pip/issues/9243 - # -r{toxinidir}/docs/requirements.in - # -c{toxinidir}/docs/requirements.txt + # -r{toxinidir}/requirements/docs.in + # -c{toxinidir}/requirements/docs.txt commands_pre = commands = # Retrieve possibly missing commits: From f5ea263b2501ba1d896df0e48bebe953682e07a4 Mon Sep 17 00:00:00 2001 From: Albert Tugushev Date: Mon, 21 Aug 2023 15:32:33 +0200 Subject: [PATCH 4/4] Revert "Move docs/requirements.* to requirements/docs.*" This reverts commit adf2a9959016f44db8e9c1412d4d239f48d8e3ec. --- .readthedocs.yaml | 2 +- requirements/docs.in => docs/requirements.in | 0 .../docs.txt => docs/requirements.txt | 12 +++++------ tox.ini | 20 +++++++++---------- 4 files changed, 16 insertions(+), 18 deletions(-) rename requirements/docs.in => docs/requirements.in (100%) rename requirements/docs.txt => docs/requirements.txt (88%) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index bb2363383..e4ddb28a9 100644 --- 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 b/docs/requirements.in similarity index 100% rename from requirements/docs.in rename to docs/requirements.in diff --git a/requirements/docs.txt b/docs/requirements.txt similarity index 88% rename from requirements/docs.txt rename to docs/requirements.txt index 4e5343180..4eb1d273e 100644 --- a/requirements/docs.txt +++ b/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 index 5c67e3594..5ded61bbe 100644 --- 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: