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

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.6.0
+Version: 0.8.0
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
-License: ISC
+License: MIT
 License-File: LICENSE
 Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
@@ -21,11 +21,11 @@ Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: charset-normalizer>=3.3.2
+Requires-Dist: charset-normalizer==3.4.1
 Requires-Dist: mkdocstrings-python==1.13.0
 Requires-Dist: mkdocstrings==0.27.0
-Requires-Dist: tree-sitter-matlab>=1.0.2
-Requires-Dist: tree-sitter>=0.23.2
+Requires-Dist: tree-sitter-matlab==1.0.3
+Requires-Dist: tree-sitter==0.23.2
 Description-Content-Type: text/markdown
 
 <!-- --8<-- [start:header] -->
@@ -40,7 +40,7 @@ Description-Content-Type: text/markdown
 [![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. 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/). 
+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/). 
 
 
 You can install this handler by specifying it as a dependency:
@@ -64,10 +64,10 @@ dependencies = [
 
 - **Support for argument validation blocks:** Tree-sitter collects your [function and method argument validation](https://mathworks.com/help/matlab/matlab_prog/function-argument-validation-1.html)
    blocks to display input and output argument types and default values. 
-   It is even able to automatically add cross-references o other objects from your API.
+   It is even able to automatically add cross-references to 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. Additionaly, the parent namespace documentation will be either extracted from the `Contents.m` or the `readme.md` file at the root of the namespace. 
+- **Recursive documentation of MATLAB [namespaces](https://mathworks.com/help/matlab/matlab_oop/namespaces.html) and folders:** 
+  just add `+` to the identifer for namespaces or the relative path for folder, and you get documentation for the entire directory. You don't need to inject documentation for each class, function, and script. Additionaly, the directory documentation will be either extracted from the `Contents.m` or the `readme.md` file at the root of the namespace or folder.
 
 - **Support for documented properties:** properties definitions followed by a docstring will be recognized in classes. 
 

mkdocstrings_matlab-0.8.0.dist-info/RECORD

@@ -0,0 +1,21 @@
+mkdocstrings_handlers/matlab/__init__.py,sha256=w5R9cGtqeJF0GUP_Jc_ad8FnS4FpbutnmHvzVRlohPM,1124
+mkdocstrings_handlers/matlab/collect.py,sha256=WXuRIDYL0T1fKv1MwwOC6uWAB80PxRCs4uYDgOHiQcg,29749
+mkdocstrings_handlers/matlab/enums.py,sha256=lr3wLlhPxyBym3O7Rt0cLUZYqPCz6wQ2PYBibLKLTek,982
+mkdocstrings_handlers/matlab/handler.py,sha256=kHyBrHTvZJBXVgondNcbjyeRna0pMmfCnIDVk7ru3oQ,19708
+mkdocstrings_handlers/matlab/models.py,sha256=L3x17w9sqFBNMEJ-3rlEbPQpHRGHl2WY_xHE26NLHsQ,19232
+mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocstrings_handlers/matlab/treesitter.py,sha256=FkWGuH7EmE_aO2qub5-_NnOVacYeXW353SkB7cNMlRo,21820
+mkdocstrings_handlers/matlab/templates/material/children.html.jinja,sha256=BydWtrB7KR27tzjbzSOZZvv1srEDUHox-vTy4RRE9zk,6456
+mkdocstrings_handlers/matlab/templates/material/folder.html.jinja,sha256=cWgaQH4EDFgL3eEIv0NRwRXYvtn9pp4tW7ntv3X2nM8,4076
+mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja,sha256=NNqL14Z01Lhx6WwK2NxusY-cwcY7HHie07L_VEt8dws,4085
+mkdocstrings_handlers/matlab/templates/material/property.html.jinja,sha256=anYCQM6AcyGgEApDC97TqzWlgVNtc1I_Ys1xyvUXye0,4396
+mkdocstrings_handlers/matlab/templates/material/style.css,sha256=0_Bs5_0fHM3X9l-IU1VHbZfhNA7nUw4SKEH_3zRhCDw,557
+mkdocstrings_handlers/matlab/templates/material/summary.html.jinja,sha256=hVbQGxbMWd6fl01afbg0LhfYCJD1IRPmmCdcDBxU650,735
+mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja,sha256=jLtPxNNfZFO3-Ozy0eHqxHvKmlPCODML_5xt8SJr8UE,3165
+mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja,sha256=9ckdYymLlB5sflwYEaEPAQLJuVWF8nezMCV5JnanXVA,4165
+mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja,sha256=0vVlUB6oh-A7cpXbuDLOQLxTubyb_DisdOKm062WNMs,650
+mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja,sha256=nyPaELf9qPCxJQFxK1MWYK4fPwsk5VESh9xKHLtd-XE,643
+mkdocstrings_matlab-0.8.0.dist-info/METADATA,sha256=Y3FVSH3Jx3tgfzfh8bmcoTQLgdtmbn70lyLzprHO9Es,4736
+mkdocstrings_matlab-0.8.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_matlab-0.8.0.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
+mkdocstrings_matlab-0.8.0.dist-info/RECORD,,

mkdocs_material_matlab/__init__.py

@@ -1,4 +0,0 @@
-from .mkdocs_material_matlab import MkdocsMaterialMatlabPlugin
-
-
-__all__ = ["MkdocsMaterialMatlabPlugin"]

mkdocs_material_matlab/css/style.css

@@ -1,7 +0,0 @@
-code.doc-symbol-attribute::after {
-  content: "prop" !important;
-}
-
-code.doc-symbol-module::after {
-  content: "name" !important;
-}

mkdocs_material_matlab/mkdocs_material_matlab.py

@@ -1,20 +0,0 @@
-from mkdocs.plugins import BasePlugin
-import os
-
-
-class MkdocsMaterialMatlabPlugin(BasePlugin):
-    def on_config(self, config):
-        # Ensure the custom CSS file is included in the extra_css list
-        css_path = "css/style.css"
-        if css_path not in config["extra_css"]:
-            config["extra_css"].append(css_path)
-        return config
-
-    def on_post_build(self, *, config):
-        # Ensure the custom CSS file is copied to the output directory
-        css_src_path = os.path.join(os.path.dirname(__file__), "css", "style.css")
-        css_dest_path = os.path.join(config["site_dir"], "css", "style.css")
-        os.makedirs(os.path.dirname(css_dest_path), exist_ok=True)
-        with open(css_src_path, "rb") as src_file:
-            with open(css_dest_path, "wb") as dest_file:
-                dest_file.write(src_file.read())

mkdocstrings_matlab-0.6.0.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=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.6.0.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[mkdocs.plugins]
-mkdocs-material-matlab = mkdocs_material_matlab:MkdocsMaterialMatlabPlugin