mkdocstrings-matlab
A MATLAB handler for mkdocstrings,
compatible with Material for MkDocs and Zensical.
A modern documentation framework for MATLAB. Automatically generate beautiful documentation pages from your MATLAB code's comments and docstrings, harnessing the power of Markdown for advanced formatting.
The MATLAB handler uses maxx to collect documentation from MATLAB source code, which in turn uses Tree-sitter and its MATLAB 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",
]
To get started, checkout the 📝 documentation.
Features
-
Compatible with both Material for Mkdocs and Zensical.
-
🤖 Data collection from source code: collection of the object-tree and the docstrings is done thanks to Tree-sitter.
-
✨ Support for argument validation blocks: Tree-sitter collects your function and method argument validation 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, and links to MathWorks documentation are generated for MATLAB builtin classes.
-
🔁 Recursive documentation of MATLAB namespaces 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.mor thereadme.mdfile at the root of the namespace or folder. -
📄 Multiple docstring-styles support: common support for Google-style, Numpydoc-style, and Sphinx-style docstrings. See Griffe's documentation on docstrings support.
-
⚠️ Admonition support in Google docstrings: blocks like
Note:orWarning:will be transformed to their admonition 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.
1 maintainer
Metadata
1 maintainer
Release files for mkdocstrings-matlab 2.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| mkdocstrings_matlab-2.1.1.tar.gz | 907.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mkdocstrings_matlab-2.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 962.5 kB
Release files / mkdocstrings_matlab-2.1.1.tar.gz
| Download URL | mkdocstrings_matlab-2.1.1.tar.gz |
|---|---|
| Size | 907.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ec1d5cfe00ce422fefa1221f29f9f06efd2d951ac368ea19a483fec97719d35f
|
|
BLAKE2b-256 checksum How to use checksums |
3b570109193b34ba203c5b33b6f671d19a51e3c17626a8a0d9922babef53b777
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / mkdocstrings_matlab-2.1.1-py3-none-any.whl
| Download URL | mkdocstrings_matlab-2.1.1-py3-none-any.whl |
|---|---|
| Size | 55.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
0cb5b06ac23dca6e97c67abde19453370ac30b50433b87efc776725a8ee0a2db
|
|
BLAKE2b-256 checksum How to use checksums |
acb9d3ef13591c0039269f48d56c00048710319a5e9570957fb4d6c038014bdd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.12.7 {"installer":{"name":"uv","version":"0.12.7","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
