From 9792afd46c8346debef5e2b945af4d4b2d682866 Mon Sep 17 00:00:00 2001 From: Floris-Jan Willemsen Date: Tue, 3 Oct 2023 17:53:02 +0200 Subject: [PATCH] Restructured dependency installation of documentation action via generated requirements.txt --- .github/workflows/docs-on-release.yml | 6 +- .github/workflows/docs.yml | 6 +- doc/requirements.txt | 94 +++++++++++++++++++++++++++ pyproject.toml | 2 +- 4 files changed, 99 insertions(+), 9 deletions(-) create mode 100644 doc/requirements.txt diff --git a/.github/workflows/docs-on-release.yml b/.github/workflows/docs-on-release.yml index 9ae341cd4..20a805519 100644 --- a/.github/workflows/docs-on-release.yml +++ b/.github/workflows/docs-on-release.yml @@ -22,12 +22,10 @@ jobs: run: | sudo apt-get update; sudo apt-get install pandoc - python -m pip install --upgrade pip - pip install poetry - poetry install --with docs - name: Build and Commit - uses: sphinx-notes/pages@v2 # NOTE when switching to v3, export dependencies to requirements.txt in pyproject.toml: `poetry export --with docs --without-hashes --format=requirements.txt > docs/requirements.txt` + uses: sphinx-notes/pages@v2 with: + requirements_path: docs/requirements.txt documentation_path: doc/source target_path: ${{ env.RELEASE_VERSION }} - name: Redirect stable to new release diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 19e49550c..cb7540a46 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -21,12 +21,10 @@ jobs: run: | sudo apt-get update; sudo apt-get install pandoc - python -m pip install --upgrade pip - pip install poetry - poetry install --with docs - name: Build and Commit - uses: sphinx-notes/pages@v2 # NOTE when switching to v3, export dependencies to requirements.txt in pyproject.toml: `poetry export --with docs --without-hashes --format=requirements.txt > docs/requirements.txt` + uses: sphinx-notes/pages@v2 with: + requirements_path: docs/requirements.txt documentation_path: doc/source target_path: latest - name: Push changes diff --git a/doc/requirements.txt b/doc/requirements.txt new file mode 100644 index 000000000..e0a9d50a6 --- /dev/null +++ b/doc/requirements.txt @@ -0,0 +1,94 @@ +alabaster==0.7.13 ; python_version >= "3.8" and python_version < "3.12" +appnope==0.1.3 ; python_version >= "3.8" and python_version < "3.12" and sys_platform == "darwin" +asttokens==2.4.0 ; python_version >= "3.8" and python_version < "3.12" +attrs==23.1.0 ; python_version >= "3.8" and python_version < "3.12" +babel==2.12.1 ; python_version >= "3.8" and python_version < "3.12" +backcall==0.2.0 ; python_version >= "3.8" and python_version < "3.12" +beautifulsoup4==4.12.2 ; python_version >= "3.8" and python_version < "3.12" +bleach==6.0.0 ; python_version >= "3.8" and python_version < "3.12" +certifi==2023.7.22 ; python_version >= "3.8" and python_version < "3.12" +cffi==1.15.1 ; python_version >= "3.8" and python_version < "3.12" and implementation_name == "pypy" +charset-normalizer==3.2.0 ; python_version >= "3.8" and python_version < "3.12" +colorama==0.4.6 ; python_version >= "3.8" and python_version < "3.12" and sys_platform == "win32" +decorator==5.1.1 ; python_version >= "3.8" and python_version < "3.12" +defusedxml==0.7.1 ; python_version >= "3.8" and python_version < "3.12" +docutils==0.18.1 ; python_version >= "3.8" and python_version < "3.12" +dom-toml==0.6.1 ; python_version >= "3.8" and python_version < "3.12" +domdf-python-tools==3.6.1 ; python_version >= "3.8" and python_version < "3.12" +exceptiongroup==1.1.3 ; python_version >= "3.8" and python_version < "3.11" +executing==1.2.0 ; python_version >= "3.8" and python_version < "3.12" +fastjsonschema==2.18.0 ; python_version >= "3.8" and python_version < "3.12" +idna==3.4 ; python_version >= "3.8" and python_version < "3.12" +imagesize==1.4.1 ; python_version >= "3.8" and python_version < "3.12" +importlib-metadata==6.8.0 ; python_version >= "3.8" and python_version < "3.10" +importlib-resources==6.1.0 ; python_version >= "3.8" and python_version < "3.9" +iniconfig==2.0.0 ; python_version >= "3.8" and python_version < "3.12" +ipython==8.12.2 ; python_version >= "3.8" and python_version < "3.12" +jedi==0.19.0 ; python_version >= "3.8" and python_version < "3.12" +jinja2==3.1.2 ; python_version >= "3.8" and python_version < "3.12" +joblib==1.3.2 ; python_version >= "3.8" and python_version < "3.12" +jsonschema-specifications==2023.7.1 ; python_version >= "3.8" and python_version < "3.12" +jsonschema==4.19.1 ; python_version >= "3.8" and python_version < "3.12" +jupyter-client==8.3.1 ; python_version >= "3.8" and python_version < "3.12" +jupyter-core==5.3.1 ; python_version >= "3.8" and python_version < "3.12" +jupyterlab-pygments==0.2.2 ; python_version >= "3.8" and python_version < "3.12" +markupsafe==2.1.3 ; python_version >= "3.8" and python_version < "3.12" +matplotlib-inline==0.1.6 ; python_version >= "3.8" and python_version < "3.12" +mistune==3.0.1 ; python_version >= "3.8" and python_version < "3.12" +natsort==8.4.0 ; python_version >= "3.8" and python_version < "3.12" +nbclient==0.8.0 ; python_version >= "3.8" and python_version < "3.12" +nbconvert==7.8.0 ; python_version >= "3.8" and python_version < "3.12" +nbformat==5.9.2 ; python_version >= "3.8" and python_version < "3.12" +nbsphinx==0.9.3 ; python_version >= "3.8" and python_version < "3.12" +numpy==1.24.4 ; python_version >= "3.8" and python_version < "3.12" +packaging==23.1 ; python_version >= "3.8" and python_version < "3.12" +pandas==1.5.3 ; python_version >= "3.8" and python_version < "3.12" +pandocfilters==1.5.0 ; python_version >= "3.8" and python_version < "3.12" +parso==0.8.3 ; python_version >= "3.8" and python_version < "3.12" +pexpect==4.8.0 ; python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32" +pickleshare==0.7.5 ; python_version >= "3.8" and python_version < "3.12" +pkgutil-resolve-name==1.3.10 ; python_version >= "3.8" and python_version < "3.9" +platformdirs==3.10.0 ; python_version >= "3.8" and python_version < "3.12" +pluggy==1.3.0 ; python_version >= "3.8" and python_version < "3.12" +prompt-toolkit==3.0.39 ; python_version >= "3.8" and python_version < "3.12" +ptyprocess==0.7.0 ; python_version >= "3.8" and python_version < "3.12" and sys_platform != "win32" +pure-eval==0.2.2 ; python_version >= "3.8" and python_version < "3.12" +pycparser==2.21 ; python_version >= "3.8" and python_version < "3.12" and implementation_name == "pypy" +pygments==2.16.1 ; python_version >= "3.8" and python_version < "3.12" +pytest==7.4.2 ; python_version >= "3.8" and python_version < "3.12" +python-constraint2==2.0.0b3 ; python_version >= "3.8" and python_version < "3.12" +python-dateutil==2.8.2 ; python_version >= "3.8" and python_version < "3.12" +pytz==2023.3.post1 ; python_version >= "3.8" and python_version < "3.12" +pywin32==306 ; sys_platform == "win32" and platform_python_implementation != "PyPy" and python_version >= "3.8" and python_version < "3.12" +pyzmq==25.1.1 ; python_version >= "3.8" and python_version < "3.12" +referencing==0.30.2 ; python_version >= "3.8" and python_version < "3.12" +requests==2.31.0 ; python_version >= "3.8" and python_version < "3.12" +rpds-py==0.10.3 ; python_version >= "3.8" and python_version < "3.12" +scikit-learn==1.3.1 ; python_version >= "3.8" and python_version < "3.12" +scipy==1.10.1 ; python_version >= "3.8" and python_version < "3.12" +six==1.16.0 ; python_version >= "3.8" and python_version < "3.12" +snowballstemmer==2.2.0 ; python_version >= "3.8" and python_version < "3.12" +soupsieve==2.5 ; python_version >= "3.8" and python_version < "3.12" +sphinx-pyproject==0.3.0 ; python_version >= "3.8" and python_version < "3.12" +sphinx-rtd-theme==1.3.0 ; python_version >= "3.8" and python_version < "3.12" +sphinx==7.1.2 ; python_version >= "3.8" and python_version < "3.12" +sphinxcontrib-applehelp==1.0.4 ; python_version >= "3.8" and python_version < "3.12" +sphinxcontrib-devhelp==1.0.2 ; python_version >= "3.8" and python_version < "3.12" +sphinxcontrib-htmlhelp==2.0.1 ; python_version >= "3.8" and python_version < "3.12" +sphinxcontrib-jquery==4.1 ; python_version >= "3.8" and python_version < "3.12" +sphinxcontrib-jsmath==1.0.1 ; python_version >= "3.8" and python_version < "3.12" +sphinxcontrib-qthelp==1.0.3 ; python_version >= "3.8" and python_version < "3.12" +sphinxcontrib-serializinghtml==1.1.5 ; python_version >= "3.8" and python_version < "3.12" +stack-data==0.6.2 ; python_version >= "3.8" and python_version < "3.12" +threadpoolctl==3.2.0 ; python_version >= "3.8" and python_version < "3.12" +tinycss2==1.2.1 ; python_version >= "3.8" and python_version < "3.12" +toml==0.10.2 ; python_version >= "3.8" and python_version < "3.12" +tomli==2.0.1 ; python_version >= "3.8" and python_version < "3.11" +tornado==6.3.3 ; python_version >= "3.8" and python_version < "3.12" +traitlets==5.10.0 ; python_version >= "3.8" and python_version < "3.12" +typing-extensions==4.8.0 ; python_version >= "3.8" and python_version < "3.12" +urllib3==2.0.5 ; python_version >= "3.8" and python_version < "3.12" +wcwidth==0.2.6 ; python_version >= "3.8" and python_version < "3.12" +webencodings==0.5.1 ; python_version >= "3.8" and python_version < "3.12" +xmltodict==0.13.0 ; python_version >= "3.8" and python_version < "3.12" +zipp==3.17.0 ; python_version >= "3.8" and python_version < "3.10" diff --git a/pyproject.toml b/pyproject.toml index 33643eb0e..50fcc96f7 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -86,7 +86,7 @@ cuda_opencl = ["pycuda", "pyopencl"] hip = ["pyhip-interface"] tutorial = ["jupyter", "matplotlib"] -# ATTENTION: if anything is changed here, run `poetry update` +# ATTENTION: if anything is changed here, run `poetry update` and `poetry export --with docs --without-hashes --format=requirements.txt > doc/requirements.txt` # Please note that there is overlap with the `dev` group [tool.poetry.group.docs] optional = true