Repository files navigation

A MATLAB handler formkdocstrings.

The MATLAB handler usesmaxx to collect documentation from MATLAB source code, which in turn usesTree-sitter and itsMATLAB parser.

You can install this handler by specifying it as a dependency:

# PEP 621 dependencies declaration# adapt to your dependencies manager[project]dependencies = ["mkdocstrings-matlab>=0.X.Y",]

• 🤖Data collection from source code: collection of the object-tree and the docstrings is done thanks toTree-sitter.

• ✨Support for argument validation blocks: Tree-sitter collects yourfunction and method argument validationblocks 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, and links to MathWorks documentation are generated for MATLAB builtin classes.

• 🔁Recursive documentation of MATLABnamespaces 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 theContents.m or thereadme.md file at the root of the namespace or folder.

• 📄Multiple docstring-styles support: common support for Google-style, Numpydoc-style,and Sphinx-style docstrings. SeeGriffe's documentation on docstrings support.

• ⚠️Admonition support in Google docstrings: blocks likeNote: orWarning: will be transformedto theiradmonition equivalent.We do not support nested admonitions in docstrings!

• 🔗Every object has a TOC entry: we render a heading for each object, meaningMkDocs picks them into the Tableof Contents, which is nicely displayed by the Material theme. Thanks tomkdocstrings 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.