mkdocstrings-matlab 1.0.10__py3-none-any.whl → 1.0.11__py3-none-any.whl

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_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

{mkdocstrings_matlab-1.0.10.dist-info → mkdocstrings_matlab-1.0.11.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 1.0.10
+Version: 1.0.11
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -19,7 +19,7 @@ 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.5.0
@@ -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.10.dist-info → mkdocstrings_matlab-1.0.11.dist-info}/RECORD

@@ -1,8 +1,8 @@
 mkdocstrings_handlers/matlab/__init__.py,sha256=zLE8MANvIbg-pEVFc9bGhhIUvqAjnSANBGqek-dm3LM,1721
 mkdocstrings_handlers/matlab/config.py,sha256=zpnTijfd21NTc_gIHSvzkOheUO4NTeNoaTyD62SIcNg,26755
-mkdocstrings_handlers/matlab/handler.py,sha256=QUvqGlFaAvNVsxkjdh8y2xM7f7J-12vU351Ed9bItps,9984
+mkdocstrings_handlers/matlab/handler.py,sha256=3hYk1Is4WM4NDlWPvZWTLWCfQ3tEjTTjI05A0QZ5M-U,10026
 mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/matlab/rendering.py,sha256=NhhgO7s6A64_s5U6Zg_wOFWHIzM3Alk6hO-so29zj7g,26227
+mkdocstrings_handlers/matlab/rendering.py,sha256=72pdSqGlj8uT4rovGCKK4OcTWbnhToS0ZzLiUFcfpw8,26637
 mkdocstrings_handlers/matlab/templates/material/attributes.html.jinja,sha256=3Wv9tRkBASmxW3NGdAw9V8mc7G6hc1pDIKmVQztlFJk,818
 mkdocstrings_handlers/matlab/templates/material/backlinks.html.jinja,sha256=FFrvIa-KH-DhT1cpc9HL0ecShR2gUVGs3VT9c1q88z8,467
 mkdocstrings_handlers/matlab/templates/material/children.html.jinja,sha256=gWV77R1BSkVlbQdY_VB9wrGSBY30bcm23skPTfOW1Fs,7517
@@ -34,7 +34,7 @@ mkdocstrings_handlers/matlab/templates/material/summary/classes.html.jinja,sha25
 mkdocstrings_handlers/matlab/templates/material/summary/functions.html.jinja,sha256=IhcY4O2HeGYjUjNQ9W9aYiNecCjrTzNVQopgRzxHtz8,921
 mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja,sha256=fWuFO5a2P-OEky2wvv95XLtB-9PTkymFC9MIQ5XS6FE,906
 mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja,sha256=lgVn15U3mg72RjmgvZxCqrRsjx2eEyZ0HM0bt1LxWMM,918
-mkdocstrings_matlab-1.0.10.dist-info/METADATA,sha256=r7pY3Y6pVsj1jVpfhSURjThcOPaKoOvgvqascR5LJt0,4617
-mkdocstrings_matlab-1.0.10.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_matlab-1.0.10.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
-mkdocstrings_matlab-1.0.10.dist-info/RECORD,,
+mkdocstrings_matlab-1.0.11.dist-info/METADATA,sha256=LzMhZxk4Kw7AQzjABoqkUp0uXbf7ce49uRM1IvwNd0U,4781
+mkdocstrings_matlab-1.0.11.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_matlab-1.0.11.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
+mkdocstrings_matlab-1.0.11.dist-info/RECORD,,