mkdocstrings-matlab 1.0.1__tar.gz → 1.0.3__tar.gz

{mkdocstrings_matlab-1.0.1 → mkdocstrings_matlab-1.0.3}/CHANGELOG.md

@@ -1,6 +1,22 @@
 # CHANGELOG
 
 
+## v1.0.3 (2025-08-20)
+
+### Bug Fixes
+
+- Griffe import ([#95](https://github.com/watermarkhu/mkdocstrings-matlab/pull/95),
+  [`5258ad8`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/5258ad8b326906282c5e40f1f2b7da80178c8fee))
+
+
+## v1.0.2 (2025-07-16)
+
+### Bug Fixes
+
+- Fix autoref for matlab domain ([#92](https://github.com/watermarkhu/mkdocstrings-matlab/pull/92),
+  [`fc8c299`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/fc8c299cd5ad8b92a8d9a0247caa41a966941423))
+
+
 ## v1.0.1 (2025-07-13)
 
 ### Bug Fixes

{mkdocstrings_matlab-1.0.1 → mkdocstrings_matlab-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 1.0.1
+Version: 1.0.3
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -21,7 +21,8 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: <3.14,>=3.10
 Requires-Dist: charset-normalizer~=3.4
-Requires-Dist: maxx~=0.2.4
+Requires-Dist: griffe~=1.12.1
+Requires-Dist: maxx~=0.2.9
 Requires-Dist: mkdocs-autorefs~=1.4
 Requires-Dist: mkdocstrings~=0.29
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'

{mkdocstrings_matlab-1.0.1 → mkdocstrings_matlab-1.0.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "1.0.1"
+version = "1.0.3"
 description = "A MATLAB handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -26,7 +26,8 @@ classifiers = [
 ]
 
 dependencies = [
-    "maxx~=0.2.4",
+    "griffe~=1.12.1",
+    "maxx~=0.2.9",
     "mkdocstrings~=0.29",
     "mkdocs-autorefs~=1.4",
     "charset-normalizer~=3.4",
@@ -38,14 +39,14 @@ pygments = { git = "https://github.com/watermarkhu/pygments", branch = "matlab"
 
 [dependency-groups]
 dev = [
-    "ty>=0.0.1a12",
-    "ruff>=0.11.7",
     "pre-commit",
+    "ty~=0.0.1a19",
+    "ruff~=0.12.9",
     "pydantic~=2.10",
-    "pytest>=8.3.5",
-    "pytest-cov>=6.1.1",
-    "inline-snapshot>=0.23.2",
-    "python-semantic-release~=10.0.0",
+    "pytest~=8.4.1",
+    "pytest-cov~=6.2.1",
+    "inline-snapshot~=0.27.2",
+    "python-semantic-release~=10.3.0",
 ]
 docs = [
     "pygments",

{mkdocstrings_matlab-1.0.1 → mkdocstrings_matlab-1.0.3}/src/mkdocstrings_handlers/matlab/__init__.py

@@ -4,8 +4,8 @@ from __future__ import annotations
 
 import logging
 
-from _griffe.docstrings import google, numpy
-from _griffe.enumerations import DocstringSectionKind
+from griffe._internal.docstrings import google, numpy
+from griffe._internal.enumerations import DocstringSectionKind
 
 from mkdocstrings_handlers.matlab.config import MatlabConfig, MatlabOptions
 from mkdocstrings_handlers.matlab.handler import MatlabHandler, get_handler

{mkdocstrings_matlab-1.0.1 → mkdocstrings_matlab-1.0.3}/src/mkdocstrings_handlers/matlab/rendering.py

@@ -11,13 +11,6 @@ from dataclasses import replace
 from re import Pattern
 from typing import TYPE_CHECKING, Any, Callable, ClassVar, Literal
 
-from _griffe.docstrings.models import (
-    DocstringParameter,
-    DocstringReturn,
-    DocstringSectionOtherParameters,
-    DocstringSectionParameters,
-    DocstringSectionReturns,
-)
 from griffe import (
     AliasResolutionError,
     CyclicAliasError,
@@ -32,6 +25,13 @@ from griffe import (
     DocstringSectionModules,
     DocstringSectionText,
 )
+from griffe._internal.docstrings.models import (
+    DocstringParameter,
+    DocstringReturn,
+    DocstringSectionOtherParameters,
+    DocstringSectionParameters,
+    DocstringSectionReturns,
+)
 from jinja2 import pass_context
 from markupsafe import Markup
 from maxx.enums import ArgumentKind
@@ -792,25 +792,24 @@ class AutorefsHook(AutorefsHookInterface):
             The context.
         """
         role = {
-            "property": "data"
-            if self.current_object.parent and self.current_object.parent.is_module
-            else "attr",
+            "property": "prop",
             "class": "class",
             "function": "meth"
             if self.current_object.parent and self.current_object.parent.is_class
             else "func",
-            "module": "mod",
+            "namespace": "name",
+            "script": "script",
         }.get(self.current_object.kind.value.lower(), "obj")
         origin = self.current_object.path
         try:
-            filepath = self.current_object.docstring.parent.filepath  # type: ignore[union-attr]
-            lineno = self.current_object.docstring.lineno or 0  # type: ignore[union-attr]
+            filepath = self.current_object.docstring.parent.filepath
+            lineno = self.current_object.docstring.lineno or 0
         except AttributeError:
             filepath = self.current_object.filepath
             lineno = 0
 
         return AutorefsHookInterface.Context(
-            domain="py",
+            domain="mat",
             role=role,
             origin=origin,
             filepath=str(filepath),

{mkdocstrings_matlab-1.0.1 → mkdocstrings_matlab-1.0.3}/test/snapshots/__init__.py

@@ -1,6 +1,8 @@
 """"""
 
-from inline_snapshot import external, snapshot
+from inline_snapshot import external, register_format_alias, snapshot
+
+register_format_alias(".html", ".txt")
 
 signature_show = snapshot(
     {

{mkdocstrings_matlab-1.0.1 → mkdocstrings_matlab-1.0.3}/test/test_end_to_end.py

@@ -8,10 +8,14 @@ from typing import TYPE_CHECKING, Any
 
 import bs4
 import pytest
-from inline_snapshot import outsource
+from inline_snapshot import outsource, register_format_alias
 
 from test import snapshots
 
+# Can be declared in conftest.py
+register_format_alias(".html", ".txt")
+
+
 if TYPE_CHECKING:
     from mkdocstrings_handlers.matlab import MatlabHandler