mkdocstrings-matlab 0.9.7__py3-none-any.whl → 1.0.0__py3-none-any.whl

mkdocstrings_handlers/matlab/templates/material/summary/functions.html.jinja

@@ -0,0 +1,25 @@
+{#- Summary of functions/methods. -#}
+
+{% block logs scoped %}
+  {#- Logging block.
+
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+{% endblock logs %}
+
+{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "functions") | list %}
+  {% with section = obj.functions
+      |filter_objects(
+        filters=config.filters,
+        members_list=members_list,
+        inherited_members=config.inherited_members,
+        private_members=config.private_members,
+        hidden_members=config.hidden_members,
+        keep_no_docstrings=config.show_if_no_docstring,
+      )
+      |order_members(config.members_order, members_list)
+      |as_functions_section(check_public=not members_list)
+    %}
+    {% if section %}{% include "docstring/functions.html.jinja" with context %}{% endif %}
+  {% endwith %}
+{% endif %}

mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja

@@ -2,20 +2,24 @@
 
 {% block logs scoped %}
   {#- Logging block.
-  
+
   This block can be used to log debug messages, deprecation messages, warnings, etc.
   -#}
 {% endblock logs %}
 
-{% with section = obj.modules
-    |filter_objects(
-      filters=config.filters,
-      members_list=members_list,
-      inherited_members=config.inherited_members,
-      keep_no_docstrings=config.show_if_no_docstring,
-    )
-    |order_members(config.members_order.alphabetical, members_list)
-    |as_modules_section(check_public=not members_list)
-  %}
-  {% if section %}{% include "docstring/namespaces"|get_template with context %}{% endif %}
-{% endwith %}
+{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "modules") | list %}
+  {% with section = obj.modules
+      |filter_objects(
+        filters=config.filters,
+        members_list=members_list,
+        inherited_members=config.inherited_members,
+        private_members=config.private_members,
+        hidden_members=config.hidden_members,
+        keep_no_docstrings=config.show_if_no_docstring,
+      )
+      |order_members("alphabetical", members_list)
+      |as_namespaces_section(check_public=not members_list)
+    %}
+    {% if section %}{% include "docstring/namespaces.html.jinja" with context %}{% endif %}
+  {% endwith %}
+{% endif %}

mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja

@@ -2,20 +2,24 @@
 
 {% block logs scoped %}
   {#- Logging block.
-  
+
   This block can be used to log debug messages, deprecation messages, warnings, etc.
   -#}
 {% endblock logs %}
 
-{% with section = obj.attributes
-    |filter_objects(
-      filters=config.filters,
-      members_list=members_list,
-      inherited_members=config.inherited_members,
-      keep_no_docstrings=config.show_if_no_docstring,
-    )
-    |order_members(config.members_order, members_list)
-    |as_attributes_section(check_public=not members_list)
-  %}
-  {% if section %}{% include "docstring/properties"|get_template with context %}{% endif %}
-{% endwith %}
+{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "properties") | list %}
+  {% with section = obj.properties
+      |filter_objects(
+        filters=config.filters,
+        members_list=members_list,
+        inherited_members=config.inherited_members,
+        private_members=config.private_members,
+        hidden_members=config.hidden_members,
+        keep_no_docstrings=config.show_if_no_docstring,
+      )
+      |order_members(config.members_order, members_list)
+      |as_properties_section(check_public=not members_list)
+    %}
+    {% if section %}{% include "docstring/properties.html.jinja" with context %}{% endif %}
+  {% endwith %}
+{% endif %}

mkdocstrings_handlers/matlab/templates/material/summary.html.jinja

@@ -2,25 +2,25 @@
 
 {% block logs scoped %}
   {#- Logging block.
-  
+
   This block can be used to log debug messages, deprecation messages, warnings, etc.
   -#}
 {% endblock logs %}
 
 {% with members_list = config.members if root_members else None %}
   {% if config.summary.modules %}
-    {% include "summary/namespaces"|get_template with context %}
+    {% include "summary/namespaces.html.jinja" with context %}
   {% endif %}
 
   {% if config.summary.classes %}
-    {% include "summary/classes"|get_template with context %}
+    {% include "summary/classes.html.jinja" with context %}
   {% endif %}
 
   {% if config.summary.functions %}
-    {% include "summary/functions"|get_template with context %}
+    {% include "summary/functions.html.jinja" with context %}
   {% endif %}
 
-  {% if config.summary.attributes %}
-    {% include "summary/properties"|get_template with context %}
+  {% if config.summary.properties %}
+    {% include "summary/properties.html.jinja" with context %}
   {% endif %}
 {% endwith %}

{mkdocstrings_matlab-0.9.7.dist-info → mkdocstrings_matlab-1.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.9.7
+Version: 1.0.0
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -14,18 +14,18 @@ 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.4.1
-Requires-Dist: mkdocstrings-python==1.13.0
-Requires-Dist: mkdocstrings==0.28.0
-Requires-Dist: tree-sitter-matlab==1.0.4
-Requires-Dist: tree-sitter==0.24.0
+Requires-Python: <3.14,>=3.10
+Requires-Dist: charset-normalizer~=3.4
+Requires-Dist: maxx~=0.2.3
+Requires-Dist: mkdocs-autorefs~=1.4
+Requires-Dist: mkdocstrings~=0.29
+Requires-Dist: tree-sitter
+Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
 Description-Content-Type: text/markdown
 
 <!-- --8<-- [start:header] -->
@@ -36,7 +36,7 @@ Description-Content-Type: text/markdown
 
 <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)
+[![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/)
 
@@ -59,30 +59,28 @@ dependencies = [
 
 ## Features
 
-- **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
+- 🤖 **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)
+- ✨ **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 to other objects from your API.
+   It is even able to automatically add cross-references to other objects from your API, and links to MathWorks documentation are generated for MATLAB builtin classes. 
 
-- **Recursive documentation of MATLAB [namespaces](https://mathworks.com/help/matlab/matlab_oop/namespaces.html) and folders:** 
+- 🔁 **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. 
-
-- **Multiple docstring-styles support:** common support for Google-style, Numpydoc-style,
+- 📄 **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
+- ⚠️ **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
+- 🔗 **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.
+- 📺 **Source code display:** *mkdocstrings* can add a collapsible div containing the highlighted source code of the MATLAB object.
 
 <!-- --8<-- [end:footer] -->

mkdocstrings_matlab-1.0.0.dist-info/RECORD

@@ -0,0 +1,41 @@
+mkdocstrings_handlers/matlab/__init__.py,sha256=_E7Q8fDJPmdKreDkw57ZNr2jwY7eoGCo6ZequXpXMbc,1703
+mkdocstrings_handlers/matlab/config.py,sha256=yuoB62JOm4vW5uJYd9mqvwIhtfmgSD34CMccc-9aEEc,26724
+mkdocstrings_handlers/matlab/handler.py,sha256=gD0ogRqzOlZAn_iv1E0xFflFj_tUmQcWUeWLPlp1RxI,9803
+mkdocstrings_handlers/matlab/logger.py,sha256=96hRpwOVyvEF0e9f8rvXnNBSBAuHEvM5a6bJNN8hjRo,3298
+mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocstrings_handlers/matlab/rendering.py,sha256=G35V7acGZ6Kw6-BnR4nU0k0EJqpmTr6sBVb0h-cet1s,25843
+mkdocstrings_handlers/matlab/templates/material/attributes.html.jinja,sha256=3Wv9tRkBASmxW3NGdAw9V8mc7G6hc1pDIKmVQztlFJk,818
+mkdocstrings_handlers/matlab/templates/material/backlinks.html.jinja,sha256=FFrvIa-KH-DhT1cpc9HL0ecShR2gUVGs3VT9c1q88z8,467
+mkdocstrings_handlers/matlab/templates/material/children.html.jinja,sha256=gWV77R1BSkVlbQdY_VB9wrGSBY30bcm23skPTfOW1Fs,7517
+mkdocstrings_handlers/matlab/templates/material/class.html.jinja,sha256=vcTCQ9Q5WRLiT6t8mMKopGSQCfmJpnI678kCBxNWmak,9706
+mkdocstrings_handlers/matlab/templates/material/docstring.html.jinja,sha256=lpdQelVsBwBi0jpO1xCqX-59SmFZ7N269JCNhiae6Pc,2666
+mkdocstrings_handlers/matlab/templates/material/expression.html.jinja,sha256=3srDE2lRULPYAo7PFvy0tMT-2FKo2r6yE8Dvtui1HMI,1921
+mkdocstrings_handlers/matlab/templates/material/folder.html.jinja,sha256=wdr9Mte9cFy_dKbpCnWN2UPreZEZo5EHG23bEHwMd9M,4004
+mkdocstrings_handlers/matlab/templates/material/function.html.jinja,sha256=xJ6E06q9vxHaOxK2cRzP1DvoWqWOCO1NIME7j64dsf8,5659
+mkdocstrings_handlers/matlab/templates/material/language.html.jinja,sha256=7gyknTiapqCM8TjUHdXkQgZMmYwcuy6Ze0pkntE7g8s,617
+mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja,sha256=oS8Hiy_BWRRw-Xf-r3Mvi7H3egR7YlKms8bIHk_ocw0,4107
+mkdocstrings_handlers/matlab/templates/material/property.html.jinja,sha256=qS3WyTyhMH5c40TukESjVRirYybGoyhNys4kECegR3I,4579
+mkdocstrings_handlers/matlab/templates/material/script.html.jinja,sha256=doIFI-HiOAqBmSP3RhUsHlE-Djk2xE-MrModxWLM-VQ,4040
+mkdocstrings_handlers/matlab/templates/material/signature.html.jinja,sha256=2J0XcBlTEGbC-UKCqoMbVmstAKMgszzGyZAIovhDSW0,3946
+mkdocstrings_handlers/matlab/templates/material/style.css,sha256=UgaVpWNzrTNzt_19wH0ryVAhs1GJ5eYK4JKJMHT4h2k,5083
+mkdocstrings_handlers/matlab/templates/material/summary.html.jinja,sha256=NgPQG1FeujVPJc6ePB1lRx7ovMuHqPkkSDVYPXoDWmA,725
+mkdocstrings_handlers/matlab/templates/material/docstring/admonition.html.jinja,sha256=VFwImgb1toxkjWqyhTNFQbyYE3d11yXI___3vpIu2u0,687
+mkdocstrings_handlers/matlab/templates/material/docstring/classes.html.jinja,sha256=ZpIs-E6_GsmeLO4KQrZCMRlvvxMBTsAxV-Yvv2n6Ess,3152
+mkdocstrings_handlers/matlab/templates/material/docstring/examples.html.jinja,sha256=Va6SCByxXE2KhJGSoUiPxkP-FF9tkoec5DA7ztudscY,967
+mkdocstrings_handlers/matlab/templates/material/docstring/functions.html.jinja,sha256=0juza6YJrZo6PA1OUrVedpS8M2FyLzkiwnofQp0gJxo,3691
+mkdocstrings_handlers/matlab/templates/material/docstring/input_arguments.html.jinja,sha256=UhN8_KJN5dqYTwEUUuWpIGhMAafLTtf97w-fPcVecWc,7008
+mkdocstrings_handlers/matlab/templates/material/docstring/name_value_arguments.html.jinja,sha256=Sz3UmyEwtSMI6BTCBlRWMk0rOKtGuPiSvNgjq_xISYg,6745
+mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja,sha256=82Xl1k3ktbONDX1ueMb9TZcKMVBV1S3Vl20ggcBtF2M,3184
+mkdocstrings_handlers/matlab/templates/material/docstring/output_arguments.html.jinja,sha256=VNY2dxduUQHYERWJoHUC3UjwsRAQ5NgL59DSNJg_lOY,6103
+mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja,sha256=72Lt32w58-NsbhwmwGxIOP7nuflXf2pYD052UW0LfQE,4157
+mkdocstrings_handlers/matlab/templates/material/languages/en.html.jinja,sha256=Oen9OTX26S-RfcGYkRQr-FVoIYo1jWpK47UB_47l6S0,1042
+mkdocstrings_handlers/matlab/templates/material/languages/ja.html.jinja,sha256=Urtwz_zgo4ij3SkThxuaCS3x0eLqD0ScejocX-wgWVs,1131
+mkdocstrings_handlers/matlab/templates/material/languages/zh.html.jinja,sha256=qV2S8ikiE1C3TBqwRvKGvAnNtWGqDLn9j_NCOmFi95E,999
+mkdocstrings_handlers/matlab/templates/material/summary/classes.html.jinja,sha256=JuPeZVFHUF398Dw_E-HWoDKlCGFgj52B4W2YJosU4pA,842
+mkdocstrings_handlers/matlab/templates/material/summary/functions.html.jinja,sha256=f19-RvEkHZO4VegiQApq71nAEA27RKwQW3S2NMmKrW4,860
+mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja,sha256=J0aPYlktc5RY3Gax6GCZDxT5qgFDB5b3eqZZXfZOHxU,845
+mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja,sha256=0wQeDtZzfLSZPHJzLG_MVzre1NSyoSHowTwYzk0JX1c,857
+mkdocstrings_matlab-1.0.0.dist-info/METADATA,sha256=bMgRu5xGL1zoOsJJyOBLzIYA7FpROlPmcO0jV8SF2dU,4716
+mkdocstrings_matlab-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_matlab-1.0.0.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
+mkdocstrings_matlab-1.0.0.dist-info/RECORD,,