Merge branch 'main' into release

Author: tmke8

.github/workflows/ci.yml

@@ -23,8 +23,8 @@ jobs:
         poetry install --no-interaction --no-root --only format
     - name: Format with black
       run: |
-        poetry run black --check -l 100 -t py38 -S ranzen/
-        poetry run black --check -l 100 -t py38 -S tests/
+        poetry run black --check -l 100 -t py310 -S ranzen/
+        poetry run black --check -l 100 -t py310 -S tests/
 
   lint_with_ruff:
     runs-on: ubuntu-latest
@@ -42,33 +42,45 @@ jobs:
         poetry install --no-interaction --no-root --only lint
     - name: Lint with ruff
       run: |
-        poetry run ruff check --format=github ranzen
+        poetry run ruff check --output-format=github ranzen
     - name: Lint tests with ruff
       run: |
-        poetry run ruff check --format=github tests
+        poetry run ruff check --output-format=github tests
 
   check_docstrings:
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: Set up Python 3.11
-      uses: actions/setup-python@v4
-      with:
-        python-version: "3.11"
-    - name: Install poetry
-      run: pipx install poetry
-    - name: Install dependencies
-      run: |
-        poetry env use 3.11
-        poetry install --no-interaction --no-root --only docs
-    - name: Check docstrings with darglint
-      run: |
-        poetry run darglint --docstring-style sphinx -v 2 -z long ranzen
-    - name: Build with sphinx
-      run: |
-        poetry run sphinx-build -W -b html ./docs ./docs/_build
+      # ----------------------------------------------
+      #  ----  check-out repo and set-up python ----
+      # ----------------------------------------------
+      - name: Check out repository
+        uses: actions/checkout@v3
+      # ----------------------------------------------
+      #  -----  install & configure poetry  -----
+      # ----------------------------------------------
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          cache: 'poetry'
+
+      # ----------------------------------------------
+      # install dependencies if cache does not exist
+      # ----------------------------------------------
+      - name: Install dependencies
+        run: |
+          poetry env use 3.10
+          poetry install --no-interaction --no-root -E all --with torchcpu --without format --without lint --with docs
+      - name: Check docstrings with pydoclint
+        run: |
+          poetry run pydoclint ranzen
+      - name: Build with sphinx
+        run: |
+          poetry run sphinx-build -W -b html ./docs ./docs/_build
 
   run_tests_and_type_checking:
     needs: [format_with_black, lint_with_ruff, check_docstrings]
@@ -85,19 +97,19 @@ jobs:
       # ----------------------------------------------
       - name: Install poetry
         run: pipx install poetry
-      - name: Set up Python 3.8
+      - name: Set up Python 3.10
         uses: actions/setup-python@v4
         with:
-          python-version: 3.8
+          python-version: "3.10"
           cache: 'poetry'
 
       # ----------------------------------------------
       # install dependencies if cache does not exist
       # ----------------------------------------------
       - name: Install dependencies
         run: |
-          poetry env use 3.8
-          poetry install --no-interaction --no-root -E all --with torchcpu --without format --without lint --without docs
+          poetry env use 3.10
+          poetry install --no-interaction --no-root -E all --with torchcpu --without format --without lint
 
       # ----------------------------------------------
       #  -----         Run type checking        -----

check_all.sh

@@ -4,7 +4,7 @@ echo "Begin check..." \
 && black ranzen \
 && black tests \
 && python -m pytest -vv tests/ \
-&& darglint --docstring-style sphinx -v 2 -z long ranzen \
+&& pydoclint ranzen \
 && pyright ranzen \
 && pyright tests \
 && echo "Check all complete!"

docs/conf.py

@@ -28,7 +28,7 @@
 
 # -- General configuration ---------------------------------------------------
 
-autoclass_content = "both"  # include both class docstring and __init__
+autoclass_content = "class"  # take info only from class docstring and not __init__
 autodoc_class_signature = "mixed"
 autodoc_default_options = {
     # Make sure that any autodoc declarations show the right members
@@ -40,23 +40,19 @@
     "autosummary-nosignatures": True,
 }
 autodoc_typehints = "description"
-autodoc_type_aliases = {
-    "pl.Trainer": "pytorch_lightning.Trainer",
-    "pl.LightningModule": "pytorch_lightning.LightningModule",
-}
-autodoc_mock_imports = [
-    "attrs",
-    "hydra",
-    "loguru",
-    "numpy",
-    "omegaconf",
-    "pandas",
-    "pytorch_lightning",
-    "torch",
-    "tqdm",
-    "wandb",
-    "wrapt",
-]
+# autodoc_mock_imports = [
+#     "attrs",
+#     "hydra",
+#     "loguru",
+#     "numpy",
+#     "omegaconf",
+#     "pandas",
+#     "pytorch_lightning",
+#     "torch",
+#     "tqdm",
+#     "wandb",
+#     "wrapt",
+# ]
 add_module_names = False
 
 # Add any Sphinx extension module names here, as strings. They can be