From 6635348a952be5ff489be4182acf6a1cf7a1123b Mon Sep 17 00:00:00 2001 From: Remco de Boer <29308176+redeboer@users.noreply.github.com> Date: Sun, 21 Jan 2024 00:02:51 +0100 Subject: [PATCH] DOC: switch to source code link button (#246) * DX: switch to Python 3.9 in developer environment * MAINT: remove docstring from `conf.py` * MAINT: remove redundant `master_doc` and `source_suffix` * MAINT: sort `html_theme_options` --- .constraints/py3.10.txt | 50 ++++++++++++------------ .constraints/py3.11.txt | 50 ++++++++++++------------ .constraints/py3.12.txt | 50 ++++++++++++------------ .constraints/py3.6.txt | 6 +-- .constraints/py3.7.txt | 16 ++++---- .constraints/py3.8.txt | 38 +++++++++--------- .constraints/py3.9.txt | 50 ++++++++++++------------ .gitpod.yml | 4 +- .pre-commit-config.yaml | 86 ++++++++++++++++++++--------------------- .readthedocs.yml | 4 +- docs/conf.py | 29 +++++--------- environment.yml | 4 +- 12 files changed, 188 insertions(+), 199 deletions(-) diff --git a/.constraints/py3.10.txt b/.constraints/py3.10.txt index f4d5c00d..080ee131 100644 --- a/.constraints/py3.10.txt +++ b/.constraints/py3.10.txt @@ -14,7 +14,7 @@ asttokens==2.4.1 async-lru==2.0.4 attrs==23.2.0 babel==2.14.0 -beautifulsoup4==4.12.2 +beautifulsoup4==4.12.3 black==23.12.1 bleach==6.1.0 cachetools==5.3.2 @@ -51,7 +51,7 @@ idna==3.6 imagesize==1.4.1 importlib-metadata==7.0.1 iniconfig==2.0.0 -ipykernel==6.28.0 +ipykernel==6.29.0 ipython==8.20.0 ipywidgets==8.1.1 isoduration==20.11.0 @@ -60,29 +60,29 @@ jedi==0.19.1 jinja2==3.1.3 json5==0.9.14 jsonpointer==2.4 -jsonschema==4.20.0 +jsonschema==4.21.1 jsonschema-specifications==2023.12.1 jupyter-cache==1.0.0 jupyter-client==8.6.0 jupyter-core==5.7.1 jupyter-events==0.9.0 -jupyter-lsp==2.2.1 -jupyter-server==2.12.4 +jupyter-lsp==2.2.2 +jupyter-server==2.12.5 jupyter-server-mathjax==0.2.6 jupyter-server-terminals==0.5.1 -jupyterlab==4.0.10 +jupyterlab==4.0.11 jupyterlab-code-formatter==2.2.1 jupyterlab-git==0.50.0 ; python_version >= "3.7.0" -jupyterlab-lsp==5.0.1 +jupyterlab-lsp==5.0.2 jupyterlab-myst==2.1.0 ; python_version >= "3.7.0" jupyterlab-pygments==0.3.0 jupyterlab-server==2.25.2 jupyterlab-widgets==3.0.9 latexcodec==2.0.1 livereload==2.6.3 -lsprotocol==2023.0.1 +lsprotocol==2024.0.0a1 markdown-it-py==3.0.0 -markupsafe==2.1.3 +markupsafe==2.1.4 matplotlib-inline==0.1.6 mdit-py-plugins==0.4.0 mdurl==0.1.2 @@ -92,16 +92,16 @@ mypy-extensions==1.0.0 myst-nb==1.0.0 myst-parser==2.0.0 nbclient==0.6.8 -nbconvert==7.14.1 +nbconvert==7.14.2 nbdime==4.0.1 nbformat==5.9.2 nbmake==1.4.6 -nest-asyncio==1.5.8 +nest-asyncio==1.5.9 nodeenv==1.8.0 notebook-shim==0.2.3 -overrides==7.4.0 +overrides==7.6.0 packaging==23.2 -pandocfilters==1.5.0 +pandocfilters==1.5.1 parso==0.8.3 particle==0.23.1 pathspec==0.12.1 @@ -111,13 +111,13 @@ pluggy==1.3.0 pre-commit==3.6.0 prometheus-client==0.19.0 prompt-toolkit==3.0.43 -psutil==5.9.7 +psutil==5.9.8 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 pybtex-docutils==1.0.3 pycparser==2.21 -pydata-sphinx-theme==0.15.1 +pydata-sphinx-theme==0.15.2 pydot==1.4.2 pygments==2.17.2 pyparsing==3.1.1 @@ -139,9 +139,9 @@ referencing==0.32.1 requests==2.31.0 rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 -rope==1.11.0 -rpds-py==0.16.2 -ruff==0.1.13 ; python_version >= "3.7.0" +rope==1.12.0 +rpds-py==0.17.1 +ruff==0.1.14 ; python_version >= "3.7.0" send2trash==1.8.2 six==1.16.0 smmap==5.0.1 @@ -160,13 +160,13 @@ sphinx-hep-pdgref==0.2.0 sphinx-pybtex-etal-style==0.0.2 ; python_version >= "3.7.0" sphinx-thebe==0.3.0 sphinx-togglebutton==0.3.2 -sphinxcontrib-applehelp==1.0.7 +sphinxcontrib-applehelp==1.0.8 sphinxcontrib-bibtex==2.6.2 -sphinxcontrib-devhelp==1.0.5 -sphinxcontrib-htmlhelp==2.0.4 +sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-htmlhelp==2.0.5 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.6 -sphinxcontrib-serializinghtml==1.1.9 +sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-serializinghtml==1.1.10 sphobjinv==2.3.1 sqlalchemy==2.0.25 stack-data==0.6.3 @@ -175,12 +175,12 @@ terminado==0.18.0 tinycss2==1.2.1 tomli==2.0.1 tornado==6.4 -tox==4.12.0 +tox==4.12.1 tqdm==4.66.1 traitlets==5.14.1 types-python-dateutil==2.8.19.20240106 types-pyyaml==6.0.12.12 -types-setuptools==69.0.0.20240106 +types-setuptools==69.0.0.20240115 typing-extensions==4.9.0 ujson==5.9.0 uri-template==1.3.0 diff --git a/.constraints/py3.11.txt b/.constraints/py3.11.txt index 65d0c780..e76e9e4e 100644 --- a/.constraints/py3.11.txt +++ b/.constraints/py3.11.txt @@ -14,7 +14,7 @@ asttokens==2.4.1 async-lru==2.0.4 attrs==23.2.0 babel==2.14.0 -beautifulsoup4==4.12.2 +beautifulsoup4==4.12.3 black==23.12.1 bleach==6.1.0 cachetools==5.3.2 @@ -50,7 +50,7 @@ idna==3.6 imagesize==1.4.1 importlib-metadata==7.0.1 iniconfig==2.0.0 -ipykernel==6.28.0 +ipykernel==6.29.0 ipython==8.20.0 ipywidgets==8.1.1 isoduration==20.11.0 @@ -59,29 +59,29 @@ jedi==0.19.1 jinja2==3.1.3 json5==0.9.14 jsonpointer==2.4 -jsonschema==4.20.0 +jsonschema==4.21.1 jsonschema-specifications==2023.12.1 jupyter-cache==1.0.0 jupyter-client==8.6.0 jupyter-core==5.7.1 jupyter-events==0.9.0 -jupyter-lsp==2.2.1 -jupyter-server==2.12.4 +jupyter-lsp==2.2.2 +jupyter-server==2.12.5 jupyter-server-mathjax==0.2.6 jupyter-server-terminals==0.5.1 -jupyterlab==4.0.10 +jupyterlab==4.0.11 jupyterlab-code-formatter==2.2.1 jupyterlab-git==0.50.0 ; python_version >= "3.7.0" -jupyterlab-lsp==5.0.1 +jupyterlab-lsp==5.0.2 jupyterlab-myst==2.1.0 ; python_version >= "3.7.0" jupyterlab-pygments==0.3.0 jupyterlab-server==2.25.2 jupyterlab-widgets==3.0.9 latexcodec==2.0.1 livereload==2.6.3 -lsprotocol==2023.0.1 +lsprotocol==2024.0.0a1 markdown-it-py==3.0.0 -markupsafe==2.1.3 +markupsafe==2.1.4 matplotlib-inline==0.1.6 mdit-py-plugins==0.4.0 mdurl==0.1.2 @@ -91,16 +91,16 @@ mypy-extensions==1.0.0 myst-nb==1.0.0 myst-parser==2.0.0 nbclient==0.6.8 -nbconvert==7.14.1 +nbconvert==7.14.2 nbdime==4.0.1 nbformat==5.9.2 nbmake==1.4.6 -nest-asyncio==1.5.8 +nest-asyncio==1.5.9 nodeenv==1.8.0 notebook-shim==0.2.3 -overrides==7.4.0 +overrides==7.6.0 packaging==23.2 -pandocfilters==1.5.0 +pandocfilters==1.5.1 parso==0.8.3 particle==0.23.1 pathspec==0.12.1 @@ -110,13 +110,13 @@ pluggy==1.3.0 pre-commit==3.6.0 prometheus-client==0.19.0 prompt-toolkit==3.0.43 -psutil==5.9.7 +psutil==5.9.8 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 pybtex-docutils==1.0.3 pycparser==2.21 -pydata-sphinx-theme==0.15.1 +pydata-sphinx-theme==0.15.2 pydot==1.4.2 pygments==2.17.2 pyparsing==3.1.1 @@ -138,9 +138,9 @@ referencing==0.32.1 requests==2.31.0 rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 -rope==1.11.0 -rpds-py==0.16.2 -ruff==0.1.13 ; python_version >= "3.7.0" +rope==1.12.0 +rpds-py==0.17.1 +ruff==0.1.14 ; python_version >= "3.7.0" send2trash==1.8.2 six==1.16.0 smmap==5.0.1 @@ -159,13 +159,13 @@ sphinx-hep-pdgref==0.2.0 sphinx-pybtex-etal-style==0.0.2 ; python_version >= "3.7.0" sphinx-thebe==0.3.0 sphinx-togglebutton==0.3.2 -sphinxcontrib-applehelp==1.0.7 +sphinxcontrib-applehelp==1.0.8 sphinxcontrib-bibtex==2.6.2 -sphinxcontrib-devhelp==1.0.5 -sphinxcontrib-htmlhelp==2.0.4 +sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-htmlhelp==2.0.5 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.6 -sphinxcontrib-serializinghtml==1.1.9 +sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-serializinghtml==1.1.10 sphobjinv==2.3.1 sqlalchemy==2.0.25 stack-data==0.6.3 @@ -173,12 +173,12 @@ tabulate==0.9.0 terminado==0.18.0 tinycss2==1.2.1 tornado==6.4 -tox==4.12.0 +tox==4.12.1 tqdm==4.66.1 traitlets==5.14.1 types-python-dateutil==2.8.19.20240106 types-pyyaml==6.0.12.12 -types-setuptools==69.0.0.20240106 +types-setuptools==69.0.0.20240115 typing-extensions==4.9.0 ujson==5.9.0 uri-template==1.3.0 diff --git a/.constraints/py3.12.txt b/.constraints/py3.12.txt index 307f103b..f8049b86 100644 --- a/.constraints/py3.12.txt +++ b/.constraints/py3.12.txt @@ -14,7 +14,7 @@ asttokens==2.4.1 async-lru==2.0.4 attrs==23.2.0 babel==2.14.0 -beautifulsoup4==4.12.2 +beautifulsoup4==4.12.3 black==23.12.1 bleach==6.1.0 cachetools==5.3.2 @@ -50,7 +50,7 @@ idna==3.6 imagesize==1.4.1 importlib-metadata==7.0.1 iniconfig==2.0.0 -ipykernel==6.28.0 +ipykernel==6.29.0 ipython==8.20.0 ipywidgets==8.1.1 isoduration==20.11.0 @@ -59,29 +59,29 @@ jedi==0.19.1 jinja2==3.1.3 json5==0.9.14 jsonpointer==2.4 -jsonschema==4.20.0 +jsonschema==4.21.1 jsonschema-specifications==2023.12.1 jupyter-cache==1.0.0 jupyter-client==8.6.0 jupyter-core==5.7.1 jupyter-events==0.9.0 -jupyter-lsp==2.2.1 -jupyter-server==2.12.4 +jupyter-lsp==2.2.2 +jupyter-server==2.12.5 jupyter-server-mathjax==0.2.6 jupyter-server-terminals==0.5.1 -jupyterlab==4.0.10 +jupyterlab==4.0.11 jupyterlab-code-formatter==2.2.1 jupyterlab-git==0.50.0 ; python_version >= "3.7.0" -jupyterlab-lsp==5.0.1 +jupyterlab-lsp==5.0.2 jupyterlab-myst==2.1.0 ; python_version >= "3.7.0" jupyterlab-pygments==0.3.0 jupyterlab-server==2.25.2 jupyterlab-widgets==3.0.9 latexcodec==2.0.1 livereload==2.6.3 -lsprotocol==2023.0.1 +lsprotocol==2024.0.0a1 markdown-it-py==3.0.0 -markupsafe==2.1.3 +markupsafe==2.1.4 matplotlib-inline==0.1.6 mdit-py-plugins==0.4.0 mdurl==0.1.2 @@ -91,16 +91,16 @@ mypy-extensions==1.0.0 myst-nb==1.0.0 myst-parser==2.0.0 nbclient==0.6.8 -nbconvert==7.14.1 +nbconvert==7.14.2 nbdime==4.0.1 nbformat==5.9.2 nbmake==1.4.6 -nest-asyncio==1.5.8 +nest-asyncio==1.5.9 nodeenv==1.8.0 notebook-shim==0.2.3 -overrides==7.4.0 +overrides==7.6.0 packaging==23.2 -pandocfilters==1.5.0 +pandocfilters==1.5.1 parso==0.8.3 particle==0.23.1 pathspec==0.12.1 @@ -110,13 +110,13 @@ pluggy==1.3.0 pre-commit==3.6.0 prometheus-client==0.19.0 prompt-toolkit==3.0.43 -psutil==5.9.7 +psutil==5.9.8 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 pybtex-docutils==1.0.3 pycparser==2.21 -pydata-sphinx-theme==0.15.1 +pydata-sphinx-theme==0.15.2 pydot==1.4.2 pygments==2.17.2 pyparsing==3.1.1 @@ -138,9 +138,9 @@ referencing==0.32.1 requests==2.31.0 rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 -rope==1.11.0 -rpds-py==0.16.2 -ruff==0.1.13 ; python_version >= "3.7.0" +rope==1.12.0 +rpds-py==0.17.1 +ruff==0.1.14 ; python_version >= "3.7.0" send2trash==1.8.2 six==1.16.0 smmap==5.0.1 @@ -159,13 +159,13 @@ sphinx-hep-pdgref==0.2.0 sphinx-pybtex-etal-style==0.0.2 ; python_version >= "3.7.0" sphinx-thebe==0.3.0 sphinx-togglebutton==0.3.2 -sphinxcontrib-applehelp==1.0.7 +sphinxcontrib-applehelp==1.0.8 sphinxcontrib-bibtex==2.6.2 -sphinxcontrib-devhelp==1.0.5 -sphinxcontrib-htmlhelp==2.0.4 +sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-htmlhelp==2.0.5 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.6 -sphinxcontrib-serializinghtml==1.1.9 +sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-serializinghtml==1.1.10 sphobjinv==2.3.1 sqlalchemy==2.0.25 stack-data==0.6.3 @@ -173,12 +173,12 @@ tabulate==0.9.0 terminado==0.18.0 tinycss2==1.2.1 tornado==6.4 -tox==4.12.0 +tox==4.12.1 tqdm==4.66.1 traitlets==5.14.1 types-python-dateutil==2.8.19.20240106 types-pyyaml==6.0.12.12 -types-setuptools==69.0.0.20240106 +types-setuptools==69.0.0.20240115 typing-extensions==4.9.0 ujson==5.9.0 uri-template==1.3.0 diff --git a/.constraints/py3.6.txt b/.constraints/py3.6.txt index 1d5bc184..0bcf1f78 100644 --- a/.constraints/py3.6.txt +++ b/.constraints/py3.6.txt @@ -12,7 +12,7 @@ async-generator==1.10 attrs==21.4.0 babel==2.11.0 backcall==0.2.0 -beautifulsoup4==4.12.2 +beautifulsoup4==4.12.3 black==22.8.0 bleach==4.1.0 certifi==2023.11.17 @@ -83,11 +83,11 @@ nbconvert==6.0.7 nbdime==4.0.1 nbformat==5.1.3 nbmake==1.2.1 -nest-asyncio==1.5.8 +nest-asyncio==1.5.9 nodeenv==1.6.0 notebook==6.4.10 packaging==21.3 -pandocfilters==1.5.0 +pandocfilters==1.5.1 parso==0.7.1 particle==0.20.1 pathspec==0.9.0 diff --git a/.constraints/py3.7.txt b/.constraints/py3.7.txt index 4afce382..dbd0dc9f 100644 --- a/.constraints/py3.7.txt +++ b/.constraints/py3.7.txt @@ -15,7 +15,7 @@ arrow==1.2.3 attrs==23.2.0 babel==2.14.0 backcall==0.2.0 -beautifulsoup4==4.12.2 +beautifulsoup4==4.12.3 black==23.3.0 bleach==6.0.0 cached-property==1.5.2 @@ -75,7 +75,7 @@ jupyter-server-fileid==0.9.1 jupyter-server-mathjax==0.2.6 jupyter-server-ydoc==0.8.0 jupyter-ydoc==0.2.5 -jupyterlab==3.6.6 +jupyterlab==3.6.7 jupyterlab-code-formatter==2.2.1 jupyterlab-git==0.44.0 ; python_version >= "3.7.0" jupyterlab-lsp==3.10.2 @@ -87,7 +87,7 @@ latexcodec==2.0.1 livereload==2.6.3 lsprotocol==2023.0.1 markdown-it-py==2.2.0 -markupsafe==2.1.3 +markupsafe==2.1.4 matplotlib-inline==0.1.6 mdit-py-plugins==0.3.5 mdurl==0.1.2 @@ -102,12 +102,12 @@ nbconvert==7.6.0 nbdime==3.2.1 nbformat==5.8.0 nbmake==1.2.1 ; python_version == "3.7.*" -nest-asyncio==1.5.8 +nest-asyncio==1.5.9 nodeenv==1.8.0 notebook==6.5.6 notebook-shim==0.2.3 packaging==23.2 -pandocfilters==1.5.0 +pandocfilters==1.5.1 parso==0.8.3 particle==0.23.1 pathspec==0.11.2 @@ -119,12 +119,12 @@ pluggy==1.2.0 pre-commit==2.21.0 prometheus-client==0.17.1 prompt-toolkit==3.0.43 -psutil==5.9.7 +psutil==5.9.8 ptyprocess==0.7.0 pybtex==0.24.0 pybtex-docutils==1.0.3 pycparser==2.21 -pydantic==1.10.13 +pydantic==1.10.14 pydata-sphinx-theme==0.13.3 pydot==1.4.2 pygments==2.17.2 @@ -149,7 +149,7 @@ requests==2.31.0 rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 rope==1.9.0 -ruff==0.1.13 ; python_version >= "3.7.0" +ruff==0.1.14 ; python_version >= "3.7.0" send2trash==1.8.2 six==1.16.0 smmap==5.0.1 diff --git a/.constraints/py3.8.txt b/.constraints/py3.8.txt index f9a9a2ed..c2c0f6e7 100644 --- a/.constraints/py3.8.txt +++ b/.constraints/py3.8.txt @@ -15,7 +15,7 @@ async-lru==2.0.4 attrs==23.2.0 babel==2.14.0 backcall==0.2.0 -beautifulsoup4==4.12.2 +beautifulsoup4==4.12.3 black==23.12.1 bleach==6.1.0 cachetools==5.3.2 @@ -53,7 +53,7 @@ imagesize==1.4.1 importlib-metadata==7.0.1 importlib-resources==6.1.1 iniconfig==2.0.0 -ipykernel==6.28.0 +ipykernel==6.29.0 ipython==8.12.3 ipywidgets==8.1.1 isoduration==20.11.0 @@ -62,29 +62,29 @@ jedi==0.19.1 jinja2==3.1.3 json5==0.9.14 jsonpointer==2.4 -jsonschema==4.20.0 +jsonschema==4.21.1 jsonschema-specifications==2023.12.1 jupyter-cache==0.6.1 jupyter-client==8.6.0 jupyter-core==5.7.1 jupyter-events==0.9.0 -jupyter-lsp==2.2.1 -jupyter-server==2.12.4 +jupyter-lsp==2.2.2 +jupyter-server==2.12.5 jupyter-server-mathjax==0.2.6 jupyter-server-terminals==0.5.1 -jupyterlab==4.0.10 +jupyterlab==4.0.11 jupyterlab-code-formatter==2.2.1 jupyterlab-git==0.50.0 ; python_version >= "3.7.0" -jupyterlab-lsp==5.0.1 +jupyterlab-lsp==5.0.2 jupyterlab-myst==2.1.0 ; python_version >= "3.7.0" jupyterlab-pygments==0.3.0 jupyterlab-server==2.25.2 jupyterlab-widgets==3.0.9 latexcodec==2.0.1 livereload==2.6.3 -lsprotocol==2023.0.1 +lsprotocol==2024.0.0a1 markdown-it-py==2.2.0 -markupsafe==2.1.3 +markupsafe==2.1.4 matplotlib-inline==0.1.6 mdit-py-plugins==0.3.5 mdurl==0.1.2 @@ -94,16 +94,16 @@ mypy-extensions==1.0.0 myst-nb==0.17.2 myst-parser==0.18.1 nbclient==0.6.8 -nbconvert==7.14.1 +nbconvert==7.14.2 nbdime==4.0.1 nbformat==5.9.2 nbmake==1.4.6 -nest-asyncio==1.5.8 +nest-asyncio==1.5.9 nodeenv==1.8.0 notebook-shim==0.2.3 -overrides==7.4.0 +overrides==7.6.0 packaging==23.2 -pandocfilters==1.5.0 +pandocfilters==1.5.1 parso==0.8.3 particle==0.23.1 pathspec==0.12.1 @@ -115,7 +115,7 @@ pluggy==1.3.0 pre-commit==3.5.0 prometheus-client==0.19.0 prompt-toolkit==3.0.43 -psutil==5.9.7 +psutil==5.9.8 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 @@ -144,9 +144,9 @@ referencing==0.32.1 requests==2.31.0 rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 -rope==1.11.0 -rpds-py==0.16.2 -ruff==0.1.13 ; python_version >= "3.7.0" +rope==1.12.0 +rpds-py==0.17.1 +ruff==0.1.14 ; python_version >= "3.7.0" send2trash==1.8.2 six==1.16.0 smmap==5.0.1 @@ -180,12 +180,12 @@ terminado==0.18.0 tinycss2==1.2.1 tomli==2.0.1 tornado==6.4 -tox==4.12.0 +tox==4.12.1 tqdm==4.66.1 traitlets==5.14.1 types-python-dateutil==2.8.19.20240106 types-pyyaml==6.0.12.12 -types-setuptools==69.0.0.20240106 +types-setuptools==69.0.0.20240115 typing-extensions==4.9.0 ; python_version < "3.10.0" ujson==5.9.0 uri-template==1.3.0 diff --git a/.constraints/py3.9.txt b/.constraints/py3.9.txt index d420d77a..94785421 100644 --- a/.constraints/py3.9.txt +++ b/.constraints/py3.9.txt @@ -14,7 +14,7 @@ asttokens==2.4.1 async-lru==2.0.4 attrs==23.2.0 babel==2.14.0 -beautifulsoup4==4.12.2 +beautifulsoup4==4.12.3 black==23.12.1 bleach==6.1.0 cachetools==5.3.2 @@ -51,7 +51,7 @@ idna==3.6 imagesize==1.4.1 importlib-metadata==7.0.1 iniconfig==2.0.0 -ipykernel==6.28.0 +ipykernel==6.29.0 ipython==8.18.1 ipywidgets==8.1.1 isoduration==20.11.0 @@ -60,29 +60,29 @@ jedi==0.19.1 jinja2==3.1.3 json5==0.9.14 jsonpointer==2.4 -jsonschema==4.20.0 +jsonschema==4.21.1 jsonschema-specifications==2023.12.1 jupyter-cache==1.0.0 jupyter-client==8.6.0 jupyter-core==5.7.1 jupyter-events==0.9.0 -jupyter-lsp==2.2.1 -jupyter-server==2.12.4 +jupyter-lsp==2.2.2 +jupyter-server==2.12.5 jupyter-server-mathjax==0.2.6 jupyter-server-terminals==0.5.1 -jupyterlab==4.0.10 +jupyterlab==4.0.11 jupyterlab-code-formatter==2.2.1 jupyterlab-git==0.50.0 ; python_version >= "3.7.0" -jupyterlab-lsp==5.0.1 +jupyterlab-lsp==5.0.2 jupyterlab-myst==2.1.0 ; python_version >= "3.7.0" jupyterlab-pygments==0.3.0 jupyterlab-server==2.25.2 jupyterlab-widgets==3.0.9 latexcodec==2.0.1 livereload==2.6.3 -lsprotocol==2023.0.1 +lsprotocol==2024.0.0a1 markdown-it-py==3.0.0 -markupsafe==2.1.3 +markupsafe==2.1.4 matplotlib-inline==0.1.6 mdit-py-plugins==0.4.0 mdurl==0.1.2 @@ -92,16 +92,16 @@ mypy-extensions==1.0.0 myst-nb==1.0.0 myst-parser==2.0.0 nbclient==0.6.8 -nbconvert==7.14.1 +nbconvert==7.14.2 nbdime==4.0.1 nbformat==5.9.2 nbmake==1.4.6 -nest-asyncio==1.5.8 +nest-asyncio==1.5.9 nodeenv==1.8.0 notebook-shim==0.2.3 -overrides==7.4.0 +overrides==7.6.0 packaging==23.2 -pandocfilters==1.5.0 +pandocfilters==1.5.1 parso==0.8.3 particle==0.23.1 pathspec==0.12.1 @@ -111,13 +111,13 @@ pluggy==1.3.0 pre-commit==3.6.0 prometheus-client==0.19.0 prompt-toolkit==3.0.43 -psutil==5.9.7 +psutil==5.9.8 ptyprocess==0.7.0 pure-eval==0.2.2 pybtex==0.24.0 pybtex-docutils==1.0.3 pycparser==2.21 -pydata-sphinx-theme==0.15.1 +pydata-sphinx-theme==0.15.2 pydot==1.4.2 pygments==2.17.2 pyparsing==3.1.1 @@ -139,9 +139,9 @@ referencing==0.32.1 requests==2.31.0 rfc3339-validator==0.1.4 rfc3986-validator==0.1.1 -rope==1.11.0 -rpds-py==0.16.2 -ruff==0.1.13 ; python_version >= "3.7.0" +rope==1.12.0 +rpds-py==0.17.1 +ruff==0.1.14 ; python_version >= "3.7.0" send2trash==1.8.2 six==1.16.0 smmap==5.0.1 @@ -160,13 +160,13 @@ sphinx-hep-pdgref==0.2.0 sphinx-pybtex-etal-style==0.0.2 ; python_version >= "3.7.0" sphinx-thebe==0.3.0 sphinx-togglebutton==0.3.2 -sphinxcontrib-applehelp==1.0.7 +sphinxcontrib-applehelp==1.0.8 sphinxcontrib-bibtex==2.6.2 -sphinxcontrib-devhelp==1.0.5 -sphinxcontrib-htmlhelp==2.0.4 +sphinxcontrib-devhelp==1.0.6 +sphinxcontrib-htmlhelp==2.0.5 sphinxcontrib-jsmath==1.0.1 -sphinxcontrib-qthelp==1.0.6 -sphinxcontrib-serializinghtml==1.1.9 +sphinxcontrib-qthelp==1.0.7 +sphinxcontrib-serializinghtml==1.1.10 sphobjinv==2.3.1 sqlalchemy==2.0.25 stack-data==0.6.3 @@ -175,12 +175,12 @@ terminado==0.18.0 tinycss2==1.2.1 tomli==2.0.1 tornado==6.4 -tox==4.12.0 +tox==4.12.1 tqdm==4.66.1 traitlets==5.14.1 types-python-dateutil==2.8.19.20240106 types-pyyaml==6.0.12.12 -types-setuptools==69.0.0.20240106 +types-setuptools==69.0.0.20240115 typing-extensions==4.9.0 ; python_version < "3.10.0" ujson==5.9.0 uri-template==1.3.0 diff --git a/.gitpod.yml b/.gitpod.yml index b24ad646..0b6148e0 100644 --- a/.gitpod.yml +++ b/.gitpod.yml @@ -1,6 +1,6 @@ tasks: - - init: pyenv local 3.8 - - init: pip install -c .constraints/py3.8.txt -e .[dev] + - init: pyenv local 3.9 + - init: pip install -c .constraints/py3.9.txt -e .[dev] github: prebuilds: diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index e5dcfa14..76ab2f1a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -14,8 +14,33 @@ repos: - id: check-hooks-apply - id: check-useless-excludes + - repo: https://github.com/kynan/nbstripout + rev: 0.6.1 + hooks: + - id: nbstripout + args: + - --extra-keys + - | + cell.attachments + cell.metadata.code_folding + cell.metadata.id + cell.metadata.pycharm + cell.metadata.user_expressions + metadata.celltoolbar + metadata.colab.name + metadata.colab.provenance + metadata.interpreter + metadata.notify_time + metadata.toc + metadata.toc-autonumbering + metadata.toc-showcode + metadata.toc-showmarkdowntxt + metadata.toc-showtags + metadata.varInspector + metadata.vscode + - repo: https://github.com/ComPWA/policy - rev: 0.2.0 + rev: 0.2.3 hooks: - id: check-dev-files args: @@ -69,6 +94,23 @@ repos: hooks: - id: blacken-docs + - repo: https://github.com/pre-commit/mirrors-prettier + rev: v4.0.0-alpha.8 + hooks: + - id: prettier + + - repo: https://github.com/ComPWA/mirrors-taplo + rev: v0.8.1 + hooks: + - id: taplo + + - repo: https://github.com/pappasam/toml-sort + rev: v0.23.1 + hooks: + - id: toml-sort + args: + - --in-place + - repo: https://github.com/python-jsonschema/check-jsonschema rev: 0.27.3 hooks: @@ -108,36 +150,6 @@ repos: types: - python - - repo: https://github.com/kynan/nbstripout - rev: 0.6.1 - hooks: - - id: nbstripout - args: - - --extra-keys - - | - cell.attachments - cell.metadata.code_folding - cell.metadata.id - cell.metadata.pycharm - cell.metadata.user_expressions - metadata.celltoolbar - metadata.colab.name - metadata.colab.provenance - metadata.interpreter - metadata.notify_time - metadata.toc - metadata.toc-autonumbering - metadata.toc-showcode - metadata.toc-showmarkdowntxt - metadata.toc-showtags - metadata.varInspector - metadata.vscode - - - repo: https://github.com/pre-commit/mirrors-prettier - rev: v4.0.0-alpha.8 - hooks: - - id: prettier - - repo: https://github.com/ComPWA/mirrors-pyright rev: v1.1.345 hooks: @@ -149,15 +161,3 @@ repos: - id: ruff args: [--fix] types_or: [python, pyi, jupyter] - - - repo: https://github.com/ComPWA/mirrors-taplo - rev: v0.8.1 - hooks: - - id: taplo - - - repo: https://github.com/pappasam/toml-sort - rev: v0.23.1 - hooks: - - id: toml-sort - args: - - --in-place diff --git a/.readthedocs.yml b/.readthedocs.yml index 21c53dad..cbe136bc 100644 --- a/.readthedocs.yml +++ b/.readthedocs.yml @@ -11,9 +11,9 @@ formats: build: os: ubuntu-22.04 tools: - python: "3.8" + python: "3.9" apt_packages: - graphviz jobs: post_install: - - pip install -c .constraints/py3.8.txt -e .[doc] + - pip install -c .constraints/py3.9.txt -e .[doc] diff --git a/docs/conf.py b/docs/conf.py index fb538412..b70edd4c 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,9 +1,3 @@ -"""Configuration file for the Sphinx documentation builder. - -This file only contains a selection of the most common options. For a full list see the -documentation: https://www.sphinx-doc.org/en/master/usage/configuration.html -""" - from __future__ import annotations import os @@ -225,14 +219,6 @@ def create_constraints_inventory() -> None: "type": "url", }, ], - "logo": {"text": REPO_TITLE}, - "repository_url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}", - "repository_branch": BRANCH, - "path_to_docs": "docs", - "use_download_button": True, - "use_edit_page_button": True, - "use_issues_button": True, - "use_repository_button": True, "launch_buttons": { "binderhub_url": "https://mybinder.org", "colab_url": "https://colab.research.google.com", @@ -241,8 +227,17 @@ def create_constraints_inventory() -> None: "thebe": True, "thebelab": True, }, + "logo": {"text": REPO_TITLE}, + "path_to_docs": "docs", + "repository_branch": BRANCH, + "repository_url": f"https://github.com/{ORGANIZATION}/{REPO_NAME}", "show_navbar_depth": 2, "show_toc_level": 2, + "use_download_button": False, + "use_edit_page_button": True, + "use_issues_button": True, + "use_repository_button": True, + "use_source_button": True, } html_title = REPO_TITLE intersphinx_mapping = { @@ -262,7 +257,6 @@ def create_constraints_inventory() -> None: "https://doi.org/10.1002/andp.19955070504", # 403 for onlinelibrary.wiley.com ] project = REPO_TITLE -master_doc = "index" modindex_common_prefix = [f"{PACKAGE}."] myst_enable_extensions = [ "amsmath", @@ -301,11 +295,6 @@ def create_constraints_inventory() -> None: project = "QRules" pygments_style = "sphinx" release = get_package_version(PACKAGE) -source_suffix = { - ".ipynb": "myst-nb", - ".md": "myst-nb", - ".rst": "restructuredtext", -} suppress_warnings = [ "myst.domains", # skipping unknown output mime type: application/json diff --git a/environment.yml b/environment.yml index 0fff9a78..bb5d7b6a 100644 --- a/environment.yml +++ b/environment.yml @@ -2,10 +2,10 @@ name: qrules channels: - defaults dependencies: - - python==3.8.* + - python==3.9.* - pip - graphviz # for binder - pip: - - -c .constraints/py3.8.txt -e .[dev] + - -c .constraints/py3.9.txt -e .[dev] variables: PRETTIER_LEGACY_CLI: "1"