mkdocstrings-matlab 0.4.2__py3-none-any.whl → 0.6.0__py3-none-any.whl

mkdocstrings_handlers/matlab/__init__.py

@@ -1,10 +1,11 @@
 """MATLAB handler for mkdocstrings."""
 
 from mkdocstrings_handlers.matlab.handler import get_handler
+from mkdocstrings_handlers.matlab import collect, handler, models, treesitter
 from _griffe.enumerations import DocstringSectionKind
 from _griffe.docstrings import numpy, google
 
-__all__ = ["get_handler"]
+__all__ = ["get_handler", "collect", "handler", "models", "treesitter"]
 
 
 # Add custom sections to the numpy and google docstring parsers

mkdocstrings_handlers/matlab/collect.py

@@ -1,3 +1,5 @@
+"""Functions and classes for collecting MATLAB objects from paths."""
+
 from collections import defaultdict, deque
 from copy import copy, deepcopy
 from pathlib import Path
@@ -236,7 +238,7 @@ class PathCollection(ModulesCollection):
                     case DocstringSectionKind.parameters:
                         section.title = "Input arguments:"
                     case DocstringSectionKind.returns:
-                        section.title= "Output arguments:"
+                        section.title = "Output arguments:"
                     case DocstringSectionKind.other_parameters:
                         section.title = "Name-Value Arguments:"
 

mkdocstrings_handlers/matlab/handler.py

@@ -1,3 +1,5 @@
+"""The mkdocstrings handler for processing MATLAB code documentation."""
+
 from pathlib import Path
 from collections import ChainMap
 from markdown import Markdown
@@ -51,6 +53,7 @@ class MatlabHandler(BaseHandler):
         "members_order": rendering.Order.alphabetical.value,
         "filters": ["!^delete$|^disp$"],
         "group_by_category": True,
+        "show_subnamespaces": False,
         "summary": False,
         "show_labels": True,
         # Docstring options
@@ -118,6 +121,7 @@ class MatlabHandler(BaseHandler):
             The `members` option takes precedence over `filters` (filters will still be applied recursively
             to lower members in the hierarchy). Default: `["!^delete$|^disp$"]`.
         group_by_category (bool): Group the object's children by categories: properties, classes, functions, and namespaces. Default: `True`.
+        show_subnamespaces (bool): When rendering a namespace, show its subnamespaces recursively. Default: `False`.
         summary (bool | dict[str, bool]): Whether to render summaries of namespaces, classes, functions (methods) and properties. Default: `False`.
         show_labels (bool): Whether to show labels of the members. Default: `True`.
 
@@ -249,6 +253,9 @@ class MatlabHandler(BaseHandler):
             }
 
         # Map docstring options
+        final_config["show_submodules"] = config.get(
+            "show_subnamespaces", False
+        )
         final_config["show_docstring_attributes"] = config.get(
             "show_docstring_properties", True
         )

mkdocstrings_handlers/matlab/models.py

@@ -1,3 +1,5 @@
+"""Classes to represent MATLAB objects and their properties."""
+
 from typing import Any, TYPE_CHECKING, Callable
 from functools import cached_property
 from pathlib import Path

mkdocstrings_handlers/matlab/treesitter.py

@@ -1,4 +1,5 @@
-# %%
+"""Tree-sitter queries to extract information from MATLAB files."""
+
 from collections import OrderedDict
 from typing import Any
 

{mkdocstrings_matlab-0.4.2.dist-info → mkdocstrings_matlab-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.4.2
+Version: 0.6.0
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: ISC
@@ -28,19 +28,20 @@ Requires-Dist: tree-sitter-matlab>=1.0.2
 Requires-Dist: tree-sitter>=0.23.2
 Description-Content-Type: text/markdown
 
+<!-- --8<-- [start:header] -->
+
 <h1 align="center">mkdocstrings-matlab</h1>
 
 <p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
 
+<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)
 [![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/)
 
-<p align="center"><img width=300px src="logo.svg"></p>
-
 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. Via the python bindings the Abstract Syntax Tree (AST) of the source code is traversed to extract useful information. The imported objected are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
 
-## Installation
 
 You can install this handler by specifying it as a dependency:
 
@@ -53,6 +54,9 @@ dependencies = [
 ]
 ```
 
+<!-- --8<-- [end:header] -->
+<!-- --8<-- [start:footer] -->
+
 ## Features
 
 - **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
@@ -63,7 +67,7 @@ dependencies = [
    It is even able to automatically add cross-references o other objects from your API.
 
 - **Recursive documentation of MATLAB [namespaces](https://mathworks.com/help/matlab/matlab_oop/namespaces.html):** 
-  just add `+` to the identifer, and you get the full namespace docs. You don't need to inject documentation for each class, function, and script.
+  just add `+` to the identifer, and you get the full namespace docs. You don't need to inject documentation for each class, function, and script. Additionaly, the parent namespace documentation will be either extracted from the `Contents.m` or the `readme.md` file at the root of the namespace. 
 
 - **Support for documented properties:** properties definitions followed by a docstring will be recognized in classes. 
 
@@ -79,4 +83,6 @@ dependencies = [
   you can reference other objects within your docstrings, with the classic Markdown syntax:
   `[this object][namespace.subnamespace.object]` or directly with `[namespace.subnamespace.object][]`
 
-- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code of the MATLAB object.
+- **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code of the MATLAB object.
+
+<!-- --8<-- [end:footer] -->

mkdocstrings_matlab-0.6.0.dist-info/RECORD

@@ -0,0 +1,15 @@
+mkdocs_material_matlab/__init__.py,sha256=9pmrwWbkIyr0T7qvADbsz3OR5bB3rWb231e6JSnwA7o,106
+mkdocs_material_matlab/mkdocs_material_matlab.py,sha256=s7vI1lv6hD8s7kDHWBfYKgN6EcldyUstGYJ45sA-VWY,850
+mkdocs_material_matlab/css/style.css,sha256=iVTPIKljgvK899jEQylD7yu9yjKfrVE_4GLaITjhk4g,132
+mkdocstrings_handlers/matlab/__init__.py,sha256=w5R9cGtqeJF0GUP_Jc_ad8FnS4FpbutnmHvzVRlohPM,1124
+mkdocstrings_handlers/matlab/collect.py,sha256=i9OudR4oJX-ELPL4GVv_AJSA5N6iZk-zTSY58dfWGNw,27512
+mkdocstrings_handlers/matlab/enums.py,sha256=lr3wLlhPxyBym3O7Rt0cLUZYqPCz6wQ2PYBibLKLTek,982
+mkdocstrings_handlers/matlab/handler.py,sha256=koMpRSftxQbI8R2l0fGfBOe36yUkne6lATwDauBa5w0,18676
+mkdocstrings_handlers/matlab/models.py,sha256=7WWZ-nLaL0dWF-vOYWP-O3kNEGKtMfa5DK_J23mkhhU,18174
+mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocstrings_handlers/matlab/treesitter.py,sha256=FkWGuH7EmE_aO2qub5-_NnOVacYeXW353SkB7cNMlRo,21820
+mkdocstrings_matlab-0.6.0.dist-info/METADATA,sha256=3Q5DCapIgie22A0okETTVhAkZKtde7wJ_G5W4SgRkJM,4779
+mkdocstrings_matlab-0.6.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_matlab-0.6.0.dist-info/entry_points.txt,sha256=qUZFuB2TKh7KPlg4dR2npfbNgNExw6O6j1vF276PtPw,92
+mkdocstrings_matlab-0.6.0.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
+mkdocstrings_matlab-0.6.0.dist-info/RECORD,,

mkdocstrings_matlab-0.4.2.dist-info/RECORD

@@ -1,15 +0,0 @@
-mkdocs_material_matlab/__init__.py,sha256=9pmrwWbkIyr0T7qvADbsz3OR5bB3rWb231e6JSnwA7o,106
-mkdocs_material_matlab/mkdocs_material_matlab.py,sha256=s7vI1lv6hD8s7kDHWBfYKgN6EcldyUstGYJ45sA-VWY,850
-mkdocs_material_matlab/css/style.css,sha256=iVTPIKljgvK899jEQylD7yu9yjKfrVE_4GLaITjhk4g,132
-mkdocstrings_handlers/matlab/__init__.py,sha256=7UCCosKn8S38xgJQQy9_1P2oMyPVsTeDkcLPVIoDneU,1000
-mkdocstrings_handlers/matlab/collect.py,sha256=JAcYih8LMU9jDgxuyqR86p6zdp5qYJNxVnE3x9c529U,27440
-mkdocstrings_handlers/matlab/enums.py,sha256=lr3wLlhPxyBym3O7Rt0cLUZYqPCz6wQ2PYBibLKLTek,982
-mkdocstrings_handlers/matlab/handler.py,sha256=k7TEv2lj8wzD9kSaN78yTBAvl6Y8ZqZiyKSzoCc2uEs,18344
-mkdocstrings_handlers/matlab/models.py,sha256=YmPE9NKsPJ4GBp6es--0yH6uH8BZLPC8xMOh1QHCmY4,18109
-mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/matlab/treesitter.py,sha256=e2rfMPFaprJ6XEPH8xk2i-DKBOY_9UNWFQWPX2R7U98,21756
-mkdocstrings_matlab-0.4.2.dist-info/METADATA,sha256=ecypbJksT4gHi5z_FMxNVDlM9JGLsE9fB_yKRZB_Lwo,4521
-mkdocstrings_matlab-0.4.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_matlab-0.4.2.dist-info/entry_points.txt,sha256=qUZFuB2TKh7KPlg4dR2npfbNgNExw6O6j1vF276PtPw,92
-mkdocstrings_matlab-0.4.2.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
-mkdocstrings_matlab-0.4.2.dist-info/RECORD,,