Merge branch 'development' into quest_tile

.github/dependabot.yml

@@ -11,3 +11,6 @@ updates:
           - "*"  # Group all Actions updates into a single larger pull request
     schedule:
       interval: monthly
+    ignore:
+      - dependency-name: "sangonzal/repository-traffic-action"
+        versions: "v1"

.github/workflows/integration_test.yml

@@ -39,11 +39,9 @@ jobs:
           EARTHDATA_PASSWORD: "${{ secrets.EARTHDATA_PASSWORD }}"
           NSIDC_LOGIN: "${{ secrets.EARTHDATA_PASSWORD }}"
         run: |
-          pytest icepyx/ --verbose --cov app \
-            icepyx/tests/test_behind_NSIDC_API_login.py \
-            icepyx/tests/test_auth.py
+          pytest icepyx/tests/integration --verbose --cov app
 
       - name: "Upload coverage report"
-        uses: "codecov/codecov-action@v4.5.0"
+        uses: "codecov/codecov-action@v4.6.0"
         with:
           token: "${{ secrets.CODECOV_TOKEN }}"

.github/workflows/typecheck.yml

@@ -0,0 +1,29 @@
+name: Typecheck
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+      - development
+
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      - name: Install package and test dependencies
+        run: |
+          python -m pip install .[complete]
+          python -m pip install -r requirements-dev.txt
+
+      - uses: jakebailey/pyright-action@v2

.github/workflows/unit_test.yml

@@ -8,6 +8,10 @@ on:
     branches:
       - "main"
       - "development"
+  workflow_run:
+    workflows: [Update UML diagrams]
+    types:
+      - completed
 
 
 jobs:
@@ -31,10 +35,9 @@ jobs:
       - name: "Run tests"
         run: |
           pytest icepyx/ --verbose --cov app \
-            --ignore=icepyx/tests/test_behind_NSIDC_API_login.py \
-            --ignore=icepyx/tests/test_auth.py
+            --ignore=icepyx/tests/integration
 
       - name: "Upload coverage report"
-        uses: "codecov/codecov-action@v4.5.0"
+        uses: "codecov/codecov-action@v4.6.0"
         with:
           token: "${{ secrets.CODECOV_TOKEN }}"

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.6.0
+    rev: v5.0.0
     hooks:
       - id: check-toml
       - id: check-yaml
@@ -26,14 +26,14 @@ repos:
           - tomli
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.6.3
+    rev: v0.8.6
     hooks:
       - id: ruff
         args: ["--fix", "--show-fixes"]
       - id: ruff-format
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.19
+    rev: v0.23
     hooks:
       - id: validate-pyproject
 

doc/source/conf.py

@@ -32,13 +32,17 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    # IMPORTANT: napoleon must be loaded before sphinx_autodoc_typehints
+    # https://github.com/tox-dev/sphinx-autodoc-typehints/issues/15
+    "sphinx.ext.napoleon",
+    "sphinx_autodoc_typehints",
     "sphinx.ext.autosectionlabel",
     "numpydoc",
     # "sphinx.ext.autosummary",
     "myst_nb",
     "contributors",  # custom extension, from pandas
     "sphinxcontrib.bibtex",
-    "sphinx_panels",
+    "sphinx_design",
     # "sphinx.ext.imgconverter", # this extension should help the latex svg warning, but results in an error instead
 ]
 myst_enable_extensions = [
@@ -79,6 +83,31 @@
 nb_execution_mode = "off"
 suppress_warnings = ["myst.header"]  # suppress non-consecutive header warning
 
+
+# -- Options for Napoleon docstring parsing ----------------------------------
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_use_admonition_for_examples = True
+napoleon_use_admonition_for_notes = True
+
+
+# -- Options for autodoc -----------------------------------------------------
+
+# Show the typehints in the description of each object instead of the signature.
+autodoc_typehints = "description"
+
+
+# -- Options for autodoc typehints--------------------------------------------
+
+# Replace Union annotations with union operator "|"
+always_use_bars_union = True
+# always_document_param_types = True
+
+# Show the default value for a parameter after its type
+typehints_defaults = "comma"
+typehints_use_return = True
+
+
 # -- Options for HTML output -------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for

doc/source/user_guide/documentation/icepyx.rst

@@ -19,3 +19,4 @@ Diagrams are updated automatically after a pull request (PR) is approved and bef
    read
    variables
    components
+   types

doc/source/user_guide/documentation/types.rst

@@ -0,0 +1,11 @@
+Types
+=====
+
+.. automodule:: icepyx.core.types
+   :members:
+   :undoc-members:
+   :exclude-members: CMRParamsBase,CMRParamsWithBbox,CMRParamsWithPolygon
+
+.. COMMENT. `exclude-members` specified above is required because those models
+   contain symbols ('[', ']') in some keys, which sphinx doesn't like.
+   See: https://github.com/sphinx-doc/sphinx/issues/11039