Merge pull request #33 from scipp/supermirror-docstrings

Supermirror docstrings + update copier + update deps

.copier-answers.yml

@@ -1,5 +1,5 @@
 # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY
-_commit: ee9a09a
+_commit: 713c40f
 _src_path: gh:scipp/copier_template
 description: Reflectometry data reduction for the European Spallation Source
 max_python: '3.12'

.github/workflows/ci.yml

@@ -27,12 +27,13 @@ jobs:
  - uses: actions/setup-python@v4
  with:
  python-version-file: '.github/workflows/python-version-ci'
- - run: python -m pip install --upgrade pip
- - run: python -m pip install -r requirements/ci.txt
- - run: tox -e static
- - uses: stefanzweifel/git-auto-commit-action@v5
+ - uses: pre-commit/action@v3.0.1
  with:
- commit_message: Apply automatic formatting
+ extra_args: --all-files
+ - uses: pre-commit-ci/lite-action@v1.0.1
+ if: always()
+ with:
+ msg: Apply automatic formatting
 
  tests:
  name: Tests

.gitignore

@@ -37,3 +37,4 @@ docs/generated/
 *.raw
 *.cif
 *.rcif
+*.ort

docs/conf.py

@@ -23,6 +23,7 @@
  'sphinx.ext.intersphinx',
  'sphinx.ext.mathjax',
  'sphinx.ext.napoleon',
+ 'sphinx.ext.viewcode',
  'sphinx_autodoc_typehints',
  'sphinx_copybutton',
  'sphinx_design',

requirements/base.in

@@ -1,8 +1,5 @@
-# Temporary until questionary (dep of copier) updates
-# See https://github.com/tmbo/questionary/blob/2df265534f3eb77aafcf70902e53e80beb1793e0/pyproject.toml#L36C43-L36C110
-prompt-toolkit==3.0.36
-# Temporary pinned until prompt-tookit conflict is resolved.
-ipython==8.9.0
+# Anything above "--- END OF CUSTOM SECTION ---"
+# will not be touched by ``make_base.py``
 # --- END OF CUSTOM SECTION ---
 # The following was generated by 'tox -e deps', DO NOT EDIT MANUALLY!
 dask

requirements/base.txt

@@ -1,4 +1,4 @@
-# SHA1:df5a1bd38eaeab3b3099d7d737171e2192615a39
+# SHA1:697621007a6df52e05884bd9bf630052e4aa6fbe
 #
 # This file is autogenerated by pip-compile-multi
 # To update, run:
@@ -7,8 +7,6 @@
 #
 asttokens==2.4.1
  # via stack-data
-backcall==0.2.0
- # via ipython
 certifi==2024.2.2
  # via requests
 charset-normalizer==3.3.2
@@ -23,15 +21,17 @@ contourpy==1.2.0
  # via matplotlib
 cycler==0.12.1
  # via matplotlib
-dask==2024.1.1
+dask==2024.2.0
  # via -r base.in
 decorator==5.1.1
  # via ipython
+exceptiongroup==1.2.0
+ # via ipython
 executing==2.0.1
  # via stack-data
-fonttools==4.47.2
+fonttools==4.49.0
  # via matplotlib
-fsspec==2023.12.2
+fsspec==2024.2.0
  # via dask
 graphviz==0.20.1
  # via -r base.in
@@ -45,27 +45,25 @@ importlib-metadata==7.0.1
  # via dask
 ipydatawidgets==4.3.5
  # via pythreejs
-ipython==8.9.0
- # via
- # -r base.in
- # ipywidgets
-ipywidgets==8.1.1
+ipython==8.22.1
+ # via ipywidgets
+ipywidgets==8.1.2
  # via
  # ipydatawidgets
  # pythreejs
 jedi==0.19.1
  # via ipython
-jupyterlab-widgets==3.0.9
+jupyterlab-widgets==3.0.10
  # via ipywidgets
 kiwisolver==1.4.5
  # via matplotlib
 locket==1.0.0
  # via partd
-matplotlib==3.8.2
+matplotlib==3.8.3
  # via plopp
 matplotlib-inline==0.1.6
  # via ipython
-numpy==1.26.3
+numpy==1.26.4
  # via
  # contourpy
  # h5py
@@ -88,20 +86,16 @@ partd==1.4.1
  # via dask
 pexpect==4.9.0
  # via ipython
-pickleshare==0.7.5
- # via ipython
 pillow==10.2.0
  # via matplotlib
 platformdirs==4.2.0
  # via pooch
-plopp==24.1.1
+plopp==24.2.0
  # via -r base.in
-pooch==1.8.0
+pooch==1.8.1
  # via scippneutron
-prompt-toolkit==3.0.36
- # via
- # -r base.in
- # ipython
+prompt-toolkit==3.0.43
+ # via ipython
 ptyprocess==0.7.0
  # via pexpect
 pure-eval==0.2.2
@@ -123,7 +117,7 @@ pyyaml==6.0.1
  # orsopy
 requests==2.31.0
  # via pooch
-sciline==24.1.1
+sciline==24.2.1
  # via -r base.in
 scipp==24.2.0
  # via
@@ -158,11 +152,11 @@ traitlets==5.14.1
  # traittypes
 traittypes==0.2.1
  # via ipydatawidgets
-urllib3==2.2.0
+urllib3==2.2.1
  # via requests
 wcwidth==0.2.13
  # via prompt-toolkit
-widgetsnbextension==4.0.9
+widgetsnbextension==4.0.10
  # via ipywidgets
 zipp==3.17.0
  # via importlib-metadata

requirements/basetest.txt

@@ -13,7 +13,7 @@ packaging==23.2
  # via pytest
 pluggy==1.4.0
  # via pytest
-pytest==8.0.0
+pytest==8.0.1
  # via -r basetest.in
 tomli==2.0.1
  # via pytest

requirements/ci.txt

@@ -23,7 +23,7 @@ filelock==3.13.1
  # virtualenv
 gitdb==4.0.11
  # via gitpython
-gitpython==3.1.41
+gitpython==3.1.42
  # via -r ci.in
 idna==3.6
  # via requests
@@ -48,9 +48,9 @@ tomli==2.0.1
  # via
  # pyproject-api
  # tox
-tox==4.12.1
+tox==4.13.0
  # via -r ci.in
-urllib3==2.2.0
+urllib3==2.2.1
  # via requests
-virtualenv==20.25.0
+virtualenv==20.25.1
  # via tox

requirements/dev.txt

@@ -14,8 +14,10 @@
 -r wheels.txt
 annotated-types==0.6.0
  # via pydantic
-anyio==4.2.0
- # via jupyter-server
+anyio==4.3.0
+ # via
+ # httpx
+ # jupyter-server
 argon2-cffi==23.1.0
  # via jupyter-server
 argon2-cffi-bindings==21.2.0
@@ -28,17 +30,23 @@ cffi==1.16.0
  # via argon2-cffi-bindings
 copier==9.1.1
  # via -r dev.in
-dunamai==1.19.0
+dunamai==1.19.2
  # via copier
 fqdn==1.5.1
  # via jsonschema
 funcy==2.0
  # via copier
+h11==0.14.0
+ # via httpcore
+httpcore==1.0.4
+ # via httpx
+httpx==0.27.0
+ # via jupyterlab
 isoduration==20.11.0
  # via jsonschema
 jinja2-ansible-filters==1.3.2
  # via copier
-json5==0.9.14
+json5==0.9.17
  # via jupyterlab-server
 jsonpointer==2.4
  # via jsonschema
@@ -59,35 +67,35 @@ jupyter-server==2.12.5
  # notebook-shim
 jupyter-server-terminals==0.5.2
  # via jupyter-server
-jupyterlab==4.0.12
+jupyterlab==4.1.2
  # via -r dev.in
-jupyterlab-server==2.25.2
+jupyterlab-server==2.25.3
  # via jupyterlab
-notebook-shim==0.2.3
+notebook-shim==0.2.4
  # via jupyterlab
 overrides==7.7.0
  # via jupyter-server
 pathspec==0.12.1
  # via copier
 pip-compile-multi==2.6.3
  # via -r dev.in
-pip-tools==7.3.0
+pip-tools==7.4.0
  # via pip-compile-multi
 plumbum==1.8.2
  # via copier
-prometheus-client==0.19.0
+prometheus-client==0.20.0
  # via jupyter-server
 pycparser==2.21
  # via cffi
-pydantic==2.6.0
+pydantic==2.6.1
  # via copier
-pydantic-core==2.16.1
+pydantic-core==2.16.2
  # via pydantic
 python-json-logger==2.0.7
  # via jupyter-events
 pyyaml-include==1.3.2
  # via copier
-questionary==2.0.1
+questionary==1.10.0
  # via copier
 rfc3339-validator==0.1.4
  # via
@@ -100,7 +108,9 @@ rfc3986-validator==0.1.1
 send2trash==1.8.2
  # via jupyter-server
 sniffio==1.3.0
- # via anyio
+ # via
+ # anyio
+ # httpx
 terminado==0.18.0
  # via
  # jupyter-server

requirements/docs.txt

@@ -24,7 +24,7 @@ beautifulsoup4==4.12.3
  # pydata-sphinx-theme
 bleach==6.1.0
  # via nbconvert
-debugpy==1.8.0
+debugpy==1.8.1
  # via ipykernel
 defusedxml==0.7.1
  # via nbconvert
@@ -38,7 +38,7 @@ fastjsonschema==2.19.1
  # via nbformat
 imagesize==1.4.1
  # via sphinx
-ipykernel==6.29.0
+ipykernel==6.29.2
  # via -r docs.in
 jinja2==3.1.3
  # via
@@ -67,7 +67,7 @@ markdown-it-py==3.0.0
  # via
  # mdit-py-plugins
  # myst-parser
-markupsafe==2.1.4
+markupsafe==2.1.5
  # via
  # jinja2
  # nbconvert
@@ -81,7 +81,7 @@ myst-parser==2.0.0
  # via -r docs.in
 nbclient==0.9.0
  # via nbconvert
-nbconvert==7.14.2
+nbconvert==7.16.1
  # via nbsphinx
 nbformat==5.9.2
  # via
@@ -106,7 +106,7 @@ referencing==0.33.0
  # via
  # jsonschema
  # jsonschema-specifications
-rpds-py==0.17.1
+rpds-py==0.18.0
  # via
  # jsonschema
  # referencing
@@ -123,7 +123,7 @@ sphinx==7.2.6
  # sphinx-autodoc-typehints
  # sphinx-copybutton
  # sphinx-design
-sphinx-autodoc-typehints==1.25.3
+sphinx-autodoc-typehints==2.0.0
  # via -r docs.in
 sphinx-copybutton==0.5.2
  # via -r docs.in

requirements/make_base.py

@@ -43,7 +43,7 @@ def write_dependencies(dependency_name: str, dependencies: List[str]) -> None:
 with open("../pyproject.toml", "rb") as toml_file:
  pyproject = tomli.load(toml_file)
  dependencies = pyproject["project"].get("dependencies")
- if not dependencies:
+ if dependencies is None:
  raise RuntimeError("No dependencies found in pyproject.toml")
  dependencies = [dep.strip().strip('"') for dep in dependencies]