mkdocstrings-matlab 0.3.0__tar.gz → 0.3.2__tar.gz

{mkdocstrings_matlab-0.3.0 → mkdocstrings_matlab-0.3.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.3.0
+Version: 0.3.2
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: ISC

{mkdocstrings_matlab-0.3.0 → mkdocstrings_matlab-0.3.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "0.3.0"
+version = "0.3.2"
 description = "A MATLAB handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }

{mkdocstrings_matlab-0.3.0 → mkdocstrings_matlab-0.3.2}/src/mkdocstrings_handlers/matlab/collect.py

@@ -200,7 +200,7 @@ class PathCollection(ModulesCollection):
             return model
         return None
 
-    def update_model(self, model: MatlabMixin, config: Mapping):
+    def update_model(self, model: MatlabMixin, config: Mapping) -> MatlabMixin:
         """
         Update the given model based on the provided configuration.
 
@@ -276,43 +276,55 @@ class PathCollection(ModulesCollection):
             document_parameters = not docstring_parameters and arguments_parameters
             document_returns = not docstring_returns and arguments_returns
 
-            if document_parameters:
-                parameters = DocstringSectionParameters(
-                    [
-                        DocstringParameter(
-                            name=param.name,
-                            value=str(param.default)
-                            if param.default is not None
-                            else None,
-                            annotation=param.annotation,
-                            description=param.docstring.value
-                            if param.docstring is not None
-                            else "",
-                        )
-                        for param in model.parameters
-                        if param.kind is not ParameterKind.keyword_only
-                    ]
+            standard_parameters = [
+                param for param in model.parameters
+                if param.kind is not ParameterKind.keyword_only
+            ]
+
+            keyword_parameters = [
+                param for param in model.parameters
+                if param.kind is ParameterKind.keyword_only
+            ]
+
+            if document_parameters and standard_parameters:
+                model.docstring._extra_sections.append(
+                    DocstringSectionParameters(
+                        [
+                            DocstringParameter(
+                                name=param.name,
+                                value=str(param.default)
+                                if param.default is not None
+                                else None,
+                                annotation=param.annotation,
+                                description=param.docstring.value
+                                if param.docstring is not None
+                                else "",
+                            )
+                            for param in standard_parameters
+                        ]
+                    )
                 )
 
-                keywords = DocstringSectionParameters(
-                    [
-                        DocstringParameter(
-                            name=param.name,
-                            value=str(param.default)
-                            if param.default is not None
-                            else None,
-                            annotation=param.annotation,
-                            description=param.docstring.value
-                            if param.docstring is not None
-                            else "",
-                        )
-                        for param in model.parameters
-                        if param.kind is ParameterKind.keyword_only
-                    ],
-                    title="Keyword Arguments:",
+            if document_parameters and keyword_parameters:
+
+                model.docstring._extra_sections.append(
+                    DocstringSectionParameters(
+                        [
+                            DocstringParameter(
+                                name=param.name,
+                                value=str(param.default)
+                                if param.default is not None
+                                else None,
+                                annotation=param.annotation,
+                                description=param.docstring.value
+                                if param.docstring is not None
+                                else "",
+                            )
+                            for param in keyword_parameters
+                        ],
+                        title="Keyword Arguments:",
+                    )
                 )
-                model.docstring._extra_sections.append(parameters)
-                model.docstring._extra_sections.append(keywords)
 
             if document_returns:
                 returns = DocstringSectionReturns(
@@ -568,12 +580,17 @@ class LazyModel:
             if (
                 member.is_file()
                 and member.suffix == ".m"
-                and member.name != "Contents.m"
                 and member != classfile
             ):
-                method = self._collect_path(member)
-                method.parent = model
-                model.members[method.name] = method
+                if member.name == "Contents.m" and model.docstring is None:
+                    contentsfile = self._collect_path(member)
+                    model.docstring = contentsfile.docstring
+                else:
+                    method = self._collect_path(member)
+                    method.parent = model
+                    model.members[method.name] = method
+        if model.docstring is None:
+            model.docstring = self._collect_readme_md(path, model)
         return model
 
     def _collect_namespace(self, path: Path) -> Namespace | None:
@@ -589,9 +606,26 @@ class LazyModel:
             elif member.is_file() and member.suffix == ".m":
                 if member.name == "Contents.m":
                     contentsfile = self._collect_path(member)
-                    contentsfile.docstring = model.docstring
+                    model.docstring = contentsfile.docstring
                 else:
                     submodel = self._path_collection._models[member].model()
                     if submodel is not None:
                         model.members[submodel.name] = submodel
+
+        if model.docstring is None:
+            model.docstring = self._collect_readme_md(path, model)
+
         return model
+
+    def _collect_readme_md(self, path, parent: MatlabMixin) -> Docstring | None:
+
+        if (path / "README.md").exists():
+            readme = path / "README.md"
+        elif (path / "readme.md").exists():
+            readme = path / "readme.md"
+        else:
+            return None
+        
+        with open(readme, "r") as file:
+            content = file.read()
+        return Docstring(content, parent=parent)

{mkdocstrings_matlab-0.3.0 → mkdocstrings_matlab-0.3.2}/src/mkdocstrings_handlers/matlab/handler.py

@@ -21,7 +21,10 @@ class MatlabHandler(BaseHandler):
     """Whether this handler is interested in enabling the creation of the `objects.inv` Sphinx inventory file."""
     fallback_theme = "material"
     """The fallback theme."""
-    fallback_config: ClassVar[dict] = {"fallback": True}
+    fallback_config: ClassVar[dict] = {
+        "fallback": True,
+        "merge_constructor_into_class": True,
+    }
     """The configuration used to collect item during autorefs fallback."""
     default_config: ClassVar[dict] = {
         # General options
@@ -51,7 +54,7 @@ class MatlabHandler(BaseHandler):
         "docstring_options": {},
         "docstring_section_style": "table",
         "create_from_argument_blocks": False,
-        "merge_constructor_into_class": False,
+        "merge_constructor_into_class": True,
         "show_if_no_docstring": False,
         "show_docstring_attributes": True,
         "show_docstring_functions": True,

{mkdocstrings_matlab-0.3.0 → mkdocstrings_matlab-0.3.2}/src/mkdocstrings_handlers/matlab/models.py

@@ -558,3 +558,7 @@ class Namespace(MatlabMixin, PathMixin, Module, MatlabObject):
 
     def __repr__(self) -> str:
         return f"Namespace({self.path!r})"
+
+    @property
+    def is_internal(self) -> bool:
+        return any(part == "+internal" for part in self.filepath.parts) if self.filepath else False