mkdocstrings-matlab 1.0.0__tar.gz → 1.0.2__tar.gz

mkdocstrings_matlab-1.0.2/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: watermarkhu

{mkdocstrings_matlab-1.0.0 → mkdocstrings_matlab-1.0.2}/.github/workflows/qualify.yaml

@@ -2,6 +2,8 @@ name: Qualify
 
 on:
   merge_group:
+  push:
+    branches: [main]
   pull_request:
     types:
       - opened
@@ -11,8 +13,7 @@ on:
       - labeled
       - unlabeled
       - edited
-    branches:
-      - main
+    branches: [main]
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}

{mkdocstrings_matlab-1.0.0 → mkdocstrings_matlab-1.0.2}/.github/workflows/release.yaml

@@ -174,7 +174,7 @@ jobs:
   document:
     name: Deploy documentation
     needs: [release]
-    if: needs.release.outputs.released == 'true' && github.event.pull_request.merged
+    if: github.event.pull_request.merged
     uses: ./.github/workflows/docs.yaml
     concurrency:
       group: gh-pages

{mkdocstrings_matlab-1.0.0 → mkdocstrings_matlab-1.0.2}/CHANGELOG.md

@@ -1,6 +1,35 @@
 # CHANGELOG
 
 
+## 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
+
+- Use mirror release of py-tree-sitter that supports language version 15
+  ([#91](https://github.com/watermarkhu/mkdocstrings-matlab/pull/91),
+  [`32f8af8`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/32f8af8b536e71490b112d97235a9d33440081ca))
+
+### Chores
+
+- Update `maxx` to v0.2.4, now using pypi release of py-tree-sitter
+  ([#91](https://github.com/watermarkhu/mkdocstrings-matlab/pull/91),
+  [`32f8af8`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/32f8af8b536e71490b112d97235a9d33440081ca))
+
+### Documentation
+
+- Refer to maxx and update credits
+  ([#90](https://github.com/watermarkhu/mkdocstrings-matlab/pull/90),
+  [`4c58809`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/4c588090dcea38468dbcc8248504ffc9e879a3d0))
+
+
 ## v1.0.0 (2025-07-07)
 
 ### Chores

{mkdocstrings_matlab-1.0.0 → mkdocstrings_matlab-1.0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 1.0.0
+Version: 1.0.2
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -21,10 +21,9 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: <3.14,>=3.10
 Requires-Dist: charset-normalizer~=3.4
-Requires-Dist: maxx~=0.2.3
+Requires-Dist: maxx~=0.2.4
 Requires-Dist: mkdocs-autorefs~=1.4
 Requires-Dist: mkdocstrings~=0.29
-Requires-Dist: tree-sitter
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
 Description-Content-Type: text/markdown
 
@@ -36,12 +35,11 @@ Description-Content-Type: text/markdown
 
 <p align="center"><img width=300px src="logo.svg"></p>
 
-[![Qualify](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml/badge.svg)](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml)
+[![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/)
 
-The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. The AST information are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
-
+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).
 
 You can install this handler by specifying it as a dependency:
 

{mkdocstrings_matlab-1.0.0 → mkdocstrings_matlab-1.0.2}/README.md

@@ -6,12 +6,11 @@
 
 <p align="center"><img width=300px src="logo.svg"></p>
 
-[![Qualify](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml/badge.svg)](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml)
+[![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/)
 
-The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. The AST information are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
-
+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).
 
 You can install this handler by specifying it as a dependency:
 

mkdocstrings_matlab-1.0.2/docs/credits.md

@@ -0,0 +1,7 @@
+# Credits
+
+This project owes its existence to the incredible [`mkdocstrings`](https://mkdocstrings.github.io/) and its primary handler [`mkdocstrings-python`](https://mkdocstrings.github.io/python/). The MATLAB handler has been very much a re-implementation of the python handler, adapted where necessary for MATLAB. Special thanks to [@paramoy](https://fosstodon.org/@pawamoy) for his efforts.
+
+Moreover, `mkdocstrings` itself extends [`mkdocs`](https://www.mkdocs.org/) and [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/), which form the foundation of the entire mkdoc* suite of documentation tools.
+
+Finally, the parsing of MATLAB docstrings is powered by [maxx](https://github.com/watermarkhu/maxx), which in turn requires [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab). These libraries enable the parsing of MATLAB source code with exceptional speed and accuracy.

{mkdocstrings_matlab-1.0.0 → mkdocstrings_matlab-1.0.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "1.0.0"
+version = "1.0.2"
 description = "A MATLAB handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -26,16 +26,14 @@ classifiers = [
 ]
 
 dependencies = [
-    "maxx~=0.2.3",
+    "maxx~=0.2.4",
     "mkdocstrings~=0.29",
     "mkdocs-autorefs~=1.4",
     "charset-normalizer~=3.4",
     "typing-extensions>=4.0; python_version < '3.11'",
-    "tree-sitter",
 ]
 
 [tool.uv.sources]
-tree-sitter = { git = "https://github.com/tree-sitter/py-tree-sitter", branch = "master" }
 pygments = { git = "https://github.com/watermarkhu/pygments", branch = "matlab" }
 
 [dependency-groups]

{mkdocstrings_matlab-1.0.0 → mkdocstrings_matlab-1.0.2}/src/mkdocstrings_handlers/matlab/rendering.py

@@ -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.0/docs/credits.md

@@ -1,7 +0,0 @@
-# Credits
-
-This project owes its existence to the incredible [`mkdocstrings`](https://mkdocstrings.github.io/), its primary extension [`mkdocstrings-python`](https://mkdocstrings.github.io/python/), and [`griffe`](https://github.com/mkdocstrings/griffe). These tools handle the templating of parsed content into HTML elements using Jinja templates, allowing much of the code and documentation to be reused and adapted for *mkdocstrings-matlab*. Special thanks to [@paramoy](https://fosstodon.org/@pawamoy) for his efforts.
-
-Moreover, `mkdocstrings` itself extends [`mkdocs`](https://www.mkdocs.org/) and [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/), which form the foundation of the entire mkdoc* suite of documentation tools.
-
-Finally, the parsing of MATLAB docstrings is powered by [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab). These libraries enable the parsing of MATLAB source code with exceptional speed and accuracy.