mkdocstrings-matlab 0.2.0__tar.gz → 0.2.2__tar.gz

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: mkdocstrings-matlab
-Version: 0.2.0
+Version: 0.2.2
 Summary: Add your description here
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License-File: LICENSE

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/mkdocs.yml

@@ -23,6 +23,6 @@ plugins:
       #     show_root_heading: true
       #     show_docstring_attributes: false
       matlab:
-        paths: ["/home/mahu/repositories/github-matlab-test-action/src"]
+        paths: ["/home/mahu/repositories/matlab-test-action/src"]
         options:
           show_root_heading: true

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "0.2.0"
+version = "0.2.2"
 description = "Add your description here"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/src/mkdocstrings_handlers/matlab/handler.py

@@ -167,6 +167,10 @@ class MatlabHandler(BaseHandler):
             
             if isinstance(ast["superclasses"], str):
                 ast["superclasses"] = [ast["superclasses"]]
+            if isinstance(ast["properties"], dict):
+                ast["properties"] = [ast["properties"]]
+            if isinstance(ast["methods"], dict):
+                ast["methods"] = [ast["methods"]]
             
             if config["show_inheritance_diagram"]:
                 # Check if class is builtin and skip superclasses if option is not set
@@ -341,7 +345,7 @@ class MatlabHandler(BaseHandler):
         elif ast["docstring"]:
             docstring = Docstring(ast["docstring"], parser=config["docstring_style"])
         else:
-            docstring
+            docstring = None
 
         model.docstring = docstring
 
@@ -390,7 +394,8 @@ class MatlabHandler(BaseHandler):
         if config["merge_init_into_class"] and model.name in model.members:
             constructor = model.members.pop(model.name)
             model.members["__init__"] = constructor
-            if constructor.docstring.value == model.docstring.value:
+
+            if getattr(constructor.docstring, 'value', '') == getattr(model.docstring, 'value', ''):
                 model.docstring = None
 
         self.models[model.canonical_path] = model

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/src/mkdocstrings_handlers/matlab/matlab/+docstring/+metadata/class.m

@@ -13,6 +13,7 @@ function data = class(object, opts)
     data.sealed = object.Sealed;
     data.abstract = object.Abstract;
     data.enumeration = object.Enumeration;
+    data.properties = arrayfun(@(prop) docstring.metadata.property(prop), object.PropertyList);
     data.superclasses = arrayfun(@(o) string(o.Name), object.SuperclassList);
     data.handle = object.HandleCompatible;
     data.aliases = object.Aliases;
@@ -43,9 +44,6 @@ function data = class(object, opts)
     end
 
     numProp = numel(object.PropertyList);
-    for iProp = numProp:-1:1
-        data.properties(iProp) = docstring.metadata.property(object.PropertyList(iProp));
-    end
 
     nameparts = split(object.Name, '.');
     data.constructor = any(strcmp(nameparts(end), [data.methods.name]));

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/src/mkdocstrings_handlers/matlab/models.py

@@ -62,7 +62,7 @@ class Class(CanonicalPathMixin, PathMixin, GriffeClass):
             for block in self._textmate.children
             if block.token == "meta.methods.matlab"
         ]:
-            for method in block.children:
+            for method in [c for c in block.children if c.token == "meta.function.matlab"]:
                 declaration = next(
                     item
                     for item in method.children

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/submodules/mkdocstrings-matlab-r2023a/pyproject.toml

@@ -35,8 +35,8 @@ classifiers = [
 
 [project.urls]
 Documentation = "http://watermarkhu.nl/mkdocstrings-matlab/"
-Repository = "https://github.com/watermarkhu/mkdocstrings-matlab-r2023a"
-Issues = "https://github.com/watermarkhu/mkdocstrings-matla-r2023a/issues"
+Repository = "https://github.com/watermarkhu/mkdocstrings-matlab"
+Issues = "https://github.com/watermarkhu/mkdocstrings-matlab/issues"
 
 
 [build-system]

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/submodules/mkdocstrings-matlab-r2023b/pyproject.toml

@@ -35,8 +35,8 @@ classifiers = [
 
 [project.urls]
 Documentation = "http://watermarkhu.nl/mkdocstrings-matlab/"
-Repository = "https://github.com/watermarkhu/mkdocstrings-matlab-r2023b"
-Issues = "https://github.com/watermarkhu/mkdocstrings-matla-r2023b/issues"
+Repository = "https://github.com/watermarkhu/mkdocstrings-matlab"
+Issues = "https://github.com/watermarkhu/mkdocstrings-matlab/issues"
 
 [build-system]
 requires = ["hatchling"]

{mkdocstrings_matlab-0.2.0 → mkdocstrings_matlab-0.2.2}/submodules/mkdocstrings-matlab-r2024a/pyproject.toml

@@ -35,8 +35,8 @@ classifiers = [
 
 [project.urls]
 Documentation = "http://watermarkhu.nl/mkdocstrings-matlab/"
-Repository = "https://github.com/watermarkhu/mkdocstrings-matlab-r2024a"
-Issues = "https://github.com/watermarkhu/mkdocstrings-matla-r2024a/issues"
+Repository = "https://github.com/watermarkhu/mkdocstrings-matlab"
+Issues = "https://github.com/watermarkhu/mkdocstrings-matlab/issues"
 
 [build-system]
 requires = ["hatchling"]

mkdocstrings_matlab-0.2.2/submodules/mkdocstrings-matlab-r2024b/.gitignore

@@ -0,0 +1,10 @@
+# python generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# venv
+.venv

mkdocstrings_matlab-0.2.2/submodules/mkdocstrings-matlab-r2024b/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Mark Shui Hu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mkdocstrings_matlab-0.2.2/submodules/mkdocstrings-matlab-r2024b/README.md

@@ -0,0 +1,4 @@
+# mkdocstrings-matlab-r2024b
+
+Submodule for [mkdocstrings-matlab](https://pypi.org/project/mkdocstrings-matlab/) required for compatiblity with MATLAB R2024b. 
+

mkdocstrings_matlab-0.2.2/submodules/mkdocstrings-matlab-r2024b/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "mkdocstrings-matlab-r2024b"
+version = "0.1.2"
+description = "Add your description here"
+authors = [
+    { name = "Mark Shui Hu", email = "watermarkhu@gmail.com" }
+]
+dependencies = [
+    "matlabengine==24.2.1",
+]
+readme = "README.md"
+requires-python = ">=3.9,<3.13"
+keywords = ["mkdocs", "mkdocstrings", "documentation", "docstring", "matlab"]
+license = {file = "LICENSE"}
+classifiers = [
+  # How mature is this project? Common values are
+  #   3 - Alpha
+  #   4 - Beta
+  #   5 - Production/Stable
+  "Development Status :: 3 - Alpha",
+
+  # Indicate who your project is intended for
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Documentation",
+
+  # Pick your license as you wish (see also "license" above)
+  "License :: OSI Approved :: MIT License",
+
+  # Specify the Python versions you support here.
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+]
+
+[project.urls]
+Documentation = "http://watermarkhu.nl/mkdocstrings-matlab/"
+Repository = "https://github.com/watermarkhu/mkdocstrings-matlab"
+Issues = "https://github.com/watermarkhu/mkdocstrings-matlab/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.rye]
+managed = true
+dev-dependencies = []
+
+[tool.hatch.metadata]
+allow-direct-references = true
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/mkdocstrings_handlers"]

mkdocstrings_matlab-0.2.2/submodules/mkdocstrings-matlab-r2024b/src/mkdocstrings_handlers/matlab_engine/__init__.py

@@ -0,0 +1,8 @@
+import matlab.engine
+from matlab.engine import MatlabExecutionError
+
+
+__all__ = ["MatlabEngine", "MatlabExecutionError"]
+
+
+MatlabEngine = matlab.engine.start_matlab