mkdocstrings-matlab 1.0.9__tar.gz → 1.0.11__tar.gz

{mkdocstrings_matlab-1.0.9 → mkdocstrings_matlab-1.0.11}/.github/workflows/docs.yaml

@@ -44,7 +44,7 @@ jobs:
           ref: ${{ inputs.ref }} 
 
       - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v7
         with:
           version: "latest"
   

{mkdocstrings_matlab-1.0.9 → mkdocstrings_matlab-1.0.11}/.github/workflows/qualify.yaml

@@ -72,7 +72,7 @@ jobs:
       uses: actions/checkout@v5
 
     - name: Set up uv
-      uses: astral-sh/setup-uv@v6
+      uses: astral-sh/setup-uv@v7
       with:
         version: "latest"
 
@@ -112,7 +112,9 @@ jobs:
 
     - name: Run tests
       run: |
-        if uv run pytest --cov mkdocstrings_handlers.matlab --tb=short -v --junit-xml=pytest.xml; then
+        if uv run pytest -v --tb=short --color=yes \
+          --cov mkdocstrings_handlers.matlab --cov-branch --cov-report=xml \
+          --junit-xml=pytest.xml; then
           echo '# ✅ Tests passed' >> $GITHUB_STEP_SUMMARY
         else
           echo '# ❌ Tests failed' >> $GITHUB_STEP_SUMMARY
@@ -129,8 +131,8 @@ jobs:
       if: (!cancelled())
       uses: actions/upload-artifact@v4
       with:
-        name: Test Results (Python ${{ matrix.python-version }})
-        path: pytest.xml
+        name: python${{ matrix.python-version }}
+        path: "*.xml"
 
   summary:
     runs-on: ubuntu-latest
@@ -138,18 +140,36 @@ jobs:
     if: (!cancelled())
     permissions:
       contents: read
-      pull-requests: write
       checks: write
+      id-token: write
+      pull-requests: write
     steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 2
+
       - name: Download Artifacts
         uses: actions/download-artifact@v5
         with:
-          path: artifacts
+          path: results
 
       - name: Publish Test Results
         uses: EnricoMi/publish-unit-test-result-action@v2
         with:
-          files: "artifacts/**/*.xml"
+          files: "results/**/pytest.xml"
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        with:
+          use_oidc: true
+          directory: results
+
+      - name: Upload test results to Codecov
+        uses: codecov/test-results-action@v1
+        with:
+          use_oidc: true
+          directory: results
 
       - name: Check all jobs
         run: |

{mkdocstrings_matlab-1.0.9 → mkdocstrings_matlab-1.0.11}/.github/workflows/release.yaml

@@ -50,7 +50,7 @@ jobs:
         git checkout -B ${{ github.ref_name }} ${{ github.sha }}
 
     - name: Set up uv
-      uses: astral-sh/setup-uv@v6
+      uses: astral-sh/setup-uv@v7
       with:
         version: "latest"
 
@@ -78,7 +78,7 @@ jobs:
 
     - name: Find Comment
       id: fc
-      uses: peter-evans/find-comment@v3
+      uses: peter-evans/find-comment@v4
       with:
         issue-number: ${{ github.event.pull_request.number }}
         comment-author: 'github-actions[bot]'
@@ -86,7 +86,7 @@ jobs:
 
     - name: Create comment
       if: steps.fc.outputs.comment-id == '' && steps.get-version.outputs.released == 'true' 
-      uses: peter-evans/create-or-update-comment@v4
+      uses: peter-evans/create-or-update-comment@v5
       with:
         issue-number: ${{ github.event.pull_request.number }}
         body: |
@@ -95,7 +95,7 @@ jobs:
           
     - name: Update comment
       if: steps.fc.outputs.comment-id != '' && steps.get-version.outputs.released == 'true' 
-      uses: peter-evans/create-or-update-comment@v4
+      uses: peter-evans/create-or-update-comment@v5
       with:
         comment-id: ${{ steps.fc.outputs.comment-id }}
         edit-mode: replace
@@ -127,7 +127,7 @@ jobs:
         ref: ${{ needs.release.outputs.next-tag }}
 
     - name: Install the latest version of uv
-      uses: astral-sh/setup-uv@v6
+      uses: astral-sh/setup-uv@v7
       with:
         version: "latest"
 
@@ -162,7 +162,7 @@ jobs:
           fetch-depth: 0 # Required to push to the documentation branch
 
       - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v6
+        uses: astral-sh/setup-uv@v7
         with:
           version: "latest"
 

{mkdocstrings_matlab-1.0.9 → mkdocstrings_matlab-1.0.11}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 1.0.9
+Version: 1.0.11
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -19,10 +19,10 @@ Classifier: Topic :: Software Development
 Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
-Requires-Python: <3.14,>=3.10
+Requires-Python: <3.15,>=3.10
 Requires-Dist: charset-normalizer~=3.4
 Requires-Dist: griffe~=1.14.0
-Requires-Dist: maxx~=0.4.2
+Requires-Dist: maxx~=0.5.0
 Requires-Dist: mkdocs-autorefs~=1.4
 Requires-Dist: mkdocstrings~=0.29
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
@@ -39,6 +39,7 @@ Description-Content-Type: text/markdown
 [![Qualify](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml/badge.svg?branch=main)](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-matlab)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
+[![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-matlab/graph/badge.svg?token=T2csKmj2o2)](https://codecov.io/github/watermarkhu/mkdocstrings-matlab)
 
 The MATLAB handler uses [maxx](https://github.com/watermarkhu/maxx) to collect documentation from MATLAB source code, which in turn uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab).
 

{mkdocstrings_matlab-1.0.9 → mkdocstrings_matlab-1.0.11}/README.md

@@ -9,6 +9,7 @@
 [![Qualify](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml/badge.svg?branch=main)](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml)
 [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-matlab)
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
+[![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-matlab/graph/badge.svg?token=T2csKmj2o2)](https://codecov.io/github/watermarkhu/mkdocstrings-matlab)
 
 The MATLAB handler uses [maxx](https://github.com/watermarkhu/maxx) to collect documentation from MATLAB source code, which in turn uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab).
 

{mkdocstrings_matlab-1.0.9 → mkdocstrings_matlab-1.0.11}/pyproject.toml

@@ -1,13 +1,13 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "1.0.9"
+version = "1.0.11"
 description = "A MATLAB handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
 ]
 license =  { text = "MIT" }
 readme = "README.md"
-requires-python = ">=3.10, <3.14"
+requires-python = ">=3.10, <3.15"
 classifiers = [
     "Development Status :: 4 - Beta",
     "Intended Audience :: Developers",
@@ -27,7 +27,7 @@ classifiers = [
 
 dependencies = [
     "griffe~=1.14.0",
-    "maxx~=0.4.2",
+    "maxx~=0.5.0",
     "mkdocstrings~=0.29",
     "mkdocs-autorefs~=1.4",
     "charset-normalizer~=3.4",
@@ -39,14 +39,14 @@ pygments = { git = "https://github.com/watermarkhu/pygments", branch = "matlab"
 
 [dependency-groups]
 dev = [
-    "ty~=0.0.1a19",
+    "ty~=0.0.1a24",
     "prek>=0.2.1",
-    "ruff~=0.13.1",
+    "ruff~=0.14.0",
     "pydantic~=2.10",
     "pytest~=8.4.1",
     "pytest-cov~=7.0.0",
     "beautifulsoup4>=4.13.3",
-    "inline-snapshot~=0.29.1",
+    "inline-snapshot~=0.30.1",
     "python-semantic-release~=10.4.1",
 ]
 docs = [

{mkdocstrings_matlab-1.0.9 → mkdocstrings_matlab-1.0.11}/src/mkdocstrings_handlers/matlab/handler.py

@@ -147,7 +147,7 @@ class MatlabHandler(BaseHandler):
             },
         )
 
-        if self.env.filters["stash_crossref"].stash:
+        if self.env.filters["stash_crossref"].stash:  # ty: ignore[possibly-missing-attribute]
             pass
 
         return html

{mkdocstrings_matlab-1.0.9 → mkdocstrings_matlab-1.0.11}/src/mkdocstrings_handlers/matlab/rendering.py

@@ -37,14 +37,7 @@ from griffe._internal.docstrings.parsers import DocstringStyle, parse
 from jinja2 import pass_context
 from markupsafe import Markup
 from maxx.enums import ArgumentKind
-from maxx.objects import (
-    Alias,
-    Class,
-    Function,
-    Namespace,
-    Object,
-    Property,
-)
+from maxx.objects import Alias, Class, Folder, Function, Namespace, Object, Property, Script
 from mkdocs_autorefs import AutorefsHookInterface
 from mkdocstrings import get_logger
 
@@ -54,6 +47,8 @@ if TYPE_CHECKING:
     from jinja2.runtime import Context
     from mkdocstrings import CollectorItem
 
+    MEMBERS = Alias | Class | Folder | Function | Namespace | Property | Script
+
 _logger = get_logger(__name__)
 
 
@@ -158,16 +153,16 @@ def do_format_signature(
 
     signature = template.render(new_context, function=function, signature=True)
     signature = str(
-        env.filters["highlight"](
+        env.filters["highlight"](  # type: ignore
             Markup.escape(signature),
-            language="matlab",
-            inline=False,
-            classes=["doc-signature"],
-            linenums=False,
+            language="matlab",  # type: ignore
+            inline=False,  # type: ignore
+            classes=["doc-signature"],  # type: ignore
+            linenums=False,  # type: ignore
         ),
     )
 
-    if stash := env.filters["stash_crossref"].stash:
+    if stash := env.filters["stash_crossref"].stash:  # ty: ignore[possibly-missing-attribute]
         for key, value in stash.items():
             signature = re.sub(rf"\b{key}\b", value, signature)
         stash.clear()
@@ -197,7 +192,7 @@ def do_format_arguments(
 
     html = template.render(context.parent, section=section)
 
-    if stash := env.filters["stash_crossref"].stash:
+    if stash := env.filters["stash_crossref"].stash:  # ty: ignore[possibly-missing-attribute]
         for key, value in stash.items():
             html = re.sub(rf"\b{key}\b", value, html)
         stash.clear()
@@ -249,16 +244,16 @@ def do_format_property(
         signature += f" = {value}"
 
     signature = str(
-        env.filters["highlight"](
+        env.filters["highlight"](  # type: ignore
             Markup.escape(signature),
-            language="python",
-            inline=False,
-            classes=["doc-signature"],
-            linenums=False,
+            language="matlab",  # type: ignore
+            inline=False,  # type: ignore
+            classes=["doc-signature"],  # type: ignore
+            linenums=False,  # type: ignore
         ),
     )
 
-    if stash := env.filters["stash_crossref"].stash:
+    if stash := env.filters["stash_crossref"].stash:  # ty: ignore[possibly-missing-attribute]
         for key, value in stash.items():
             signature = re.sub(rf"\b{key}\b", value, signature)
         stash.clear()
@@ -341,7 +336,7 @@ def _parents(obj: Alias) -> set[str]:
     return parents
 
 
-def _remove_cycles(objects: list[Object | Alias]) -> Iterator[Object | Alias]:
+def _remove_cycles(objects: list[MEMBERS]) -> Iterator[MEMBERS]:
     """
     Filter objects to remove those that create cycles in the inheritance graph.
 
@@ -361,7 +356,7 @@ def _remove_cycles(objects: list[Object | Alias]) -> Iterator[Object | Alias]:
 
 
 def do_filter_objects(
-    objects_dictionary: dict[str, Object | Alias],
+    objects_dictionary: dict[str, MEMBERS],
     *,
     filters: Sequence[tuple[Pattern, bool]] | None = None,
     members_list: bool | list[str] | None = None,
@@ -369,7 +364,7 @@ def do_filter_objects(
     private_members: bool | list[str] = False,
     hidden_members: bool | list[str] = False,
     keep_no_docstrings: bool = True,
-) -> list[Object | Alias]:
+) -> list[MEMBERS]:
     """Filter a dictionary of objects based on their docstrings.
 
     Parameters:
@@ -817,8 +812,8 @@ class AutorefsHook(AutorefsHookInterface):
         }.get(self.current_object.kind.value.lower(), "obj")
         origin = self.current_object.path
         try:
-            filepath = self.current_object.docstring.parent.filepath
-            lineno = self.current_object.docstring.lineno or 0
+            filepath = self.current_object.docstring.parent.filepath  # ty: ignore[possibly-missing-attribute]
+            lineno = self.current_object.docstring.lineno or 0  # ty: ignore[possibly-missing-attribute]
         except AttributeError:
             filepath = self.current_object.filepath
             lineno = 0