Skip to main content

mkdocstrings-matlab

A MATLAB handler for mkdocstrings,
compatible with Material for MkDocs and Zensical.

Qualify documentation pypi version codecov

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 the Contents.m or the readme.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. See Griffe's documentation on docstrings support.

  • ⚠️ Admonition support in Google docstrings: blocks like Note: or Warning: 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.

Metadata

Release files for mkdocstrings-matlab 2.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mkdocstrings-matlab 2.2.0
File Size Uploaded Provenance Actions
mkdocstrings_matlab-2.2.0.tar.gz 1.0 MB Without provenance Details for mkdocstrings_matlab-2.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mkdocstrings-matlab 2.2.0
File Interpreter ABI Platform Actions
mkdocstrings_matlab-2.2.0-py3-none-any.whl Python 3 none any Details for mkdocstrings_matlab-2.2.0-py3-none-any.whl

Total release size: 1.1 MB

Release files / mkdocstrings_matlab-2.2.0.tar.gz

Download URL mkdocstrings_matlab-2.2.0.tar.gz
Size 1.0 MB
Tags Source
SHA-256 checksum
How to use checksums
9971f7963a7e7d95f2f1c8f745669916d913819390bc899cdcd8959b4de76a14
BLAKE2b-256 checksum
How to use checksums
7b8063abe46e64476a99fd4c95f6220d0ffb052ea138875a23bd55a5392e5eff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","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.2.0-py3-none-any.whl

Download URL mkdocstrings_matlab-2.2.0-py3-none-any.whl
Size 58.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e5a7fcec038a98e210a1ab8e36c40e8dbb31bdb9d87899e80e9e6ac4d3ee5f30
BLAKE2b-256 checksum
How to use checksums
d6bc26772adc493cd84b3f26380192de3745fc5ff1ab894f30f91f0beaa4fc9a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Security for mkdocstrings-matlab 2.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2.2.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page