mkdocstrings-matlab 0.3.0__py3-none-any.whl

mkdocstrings_matlab-0.3.0.dist-info/METADATA

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: mkdocstrings-matlab
+Version: 0.3.0
+Summary: A MATLAB handler for mkdocstrings
+Author-email: Mark Hu <watermarkhu@gmail.com>
+License: ISC
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Documentation
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Utilities
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: charset-normalizer>=3.3.2
+Requires-Dist: griffe>=1.5.1
+Requires-Dist: mkdocs>=1.6.0
+Requires-Dist: mkdocstrings[python]>=0.18
+Requires-Dist: tree-sitter-matlab>=1.0.2
+Requires-Dist: tree-sitter>=0.23.2
+Description-Content-Type: text/markdown
+
+<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 src="logo.png"></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:
+
+```toml title="pyproject.toml"
+# PEP 621 dependencies declaration
+# adapt to your dependencies manager
+[project]
+dependencies = [
+    "mkdocstrings-matlab>=0.3",
+]
+```
+
+## Features
+
+- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
+  [Tree-sitter](https://tree-sitter.github.io/tree-sitter/).
+
+- **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.
+
+- **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.
+
+- **Support for documented properties:** properties definitions followed by a docstring will be recognized in classes. 
+
+- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style,
+  and Sphinx-style docstrings. See [Griffe's documentation](https://mkdocstrings.github.io/griffe/docstrings/) on docstrings support.
+
+- **Admonition support in Google docstrings:** blocks like `Note:` or `Warning:` will be transformed
+  to their [admonition](https://squidfunk.github.io/mkdocs-material/reference/admonitions/) equivalent.
+  *We do not support nested admonitions in docstrings!*
+
+- **Every object has a TOC entry:** we render a heading for each object, meaning *MkDocs* picks them into the Table
+  of Contents, which is nicely displayed by the Material theme. Thanks to *mkdocstrings* cross-reference ability,
+  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.

mkdocstrings_matlab-0.3.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=laA2bEP5rxdIWBLmfLiKKu7ChZ_HzCe-VeRvxmUTqww,128
+mkdocstrings_handlers/matlab/collect.py,sha256=bPQ8e7ENzGA6b_0PGOeZSRoQozwvT7dQLZI_CoglTuk,21815
+mkdocstrings_handlers/matlab/enums.py,sha256=lr3wLlhPxyBym3O7Rt0cLUZYqPCz6wQ2PYBibLKLTek,982
+mkdocstrings_handlers/matlab/handler.py,sha256=w_k3jBaBwv3CYxGOg6cELHE1Z8p-nmxPEk-201tjLtE,15367
+mkdocstrings_handlers/matlab/models.py,sha256=fMDdzrANnsnkYl-Q8QYFgM3OxtnbJwKcKtVFFBKio_c,17363
+mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocstrings_handlers/matlab/treesitter.py,sha256=dW4RcSep4A0L505WbAE9PGL2sTqizX7nhXLwQqbJh8Y,21726
+mkdocstrings_matlab-0.3.0.dist-info/METADATA,sha256=qctHYlZnFKUY3j4C4_JTBO-G-qcG2foYWHpwLFtxUYA,4097
+mkdocstrings_matlab-0.3.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_matlab-0.3.0.dist-info/entry_points.txt,sha256=qUZFuB2TKh7KPlg4dR2npfbNgNExw6O6j1vF276PtPw,92
+mkdocstrings_matlab-0.3.0.dist-info/licenses/LICENSE,sha256=z5Ee0lckFL6K9LhLKftDu0JDl2Uie24Po20IclVk2SI,743
+mkdocstrings_matlab-0.3.0.dist-info/RECORD,,

mkdocstrings_matlab-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

mkdocstrings_matlab-0.3.0.dist-info/entry_points.txt

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

mkdocstrings_matlab-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,15 @@
+MIT License
+
+Copyright (c) 2024 Mark Shui Hu
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.