Draft
Conversation
Agent-Logs-Url: https://github.com/watermarkhu/mkdocstrings-matlab/sessions/801aea9f-d24b-44db-8b4f-1712677763f0 Co-authored-by: watermarkhu <18556882+watermarkhu@users.noreply.github.com>
…rameters Agent-Logs-Url: https://github.com/watermarkhu/mkdocstrings-matlab/sessions/801aea9f-d24b-44db-8b4f-1712677763f0 Co-authored-by: watermarkhu <18556882+watermarkhu@users.noreply.github.com>
…ocstring Agent-Logs-Url: https://github.com/watermarkhu/mkdocstrings-matlab/sessions/801aea9f-d24b-44db-8b4f-1712677763f0 Co-authored-by: watermarkhu <18556882+watermarkhu@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add documentation support for MATLAB livescript
Add MATLAB live script documentation support
Apr 5, 2026
Contributor
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds documentation rendering for MATLAB live scripts (
.mlxbinary format and R2025a plain-text.mformat), invoked by relative file path from the config file. Comment blocks become documentation text; code blocks become highlighted MATLAB code.Changes
Collection (
handler.py).mlxor containing/pointing to a.mlx/.mfile is parsed viamaxx.livescript.LiveScriptParserrather than the MATLAB symbol lookupparse_live_scriptsconfig flag through toPathsCollectionConfiguration (
config.py)parse_live_scripts: bool = Falseoption — enables indexing.mlxfiles inPathsCollectionso they can also be referenced by stem nameRendering (
rendering.py,live_script.html.jinja)do_strip_livescript_commentsfilter strips%/%prefixes from R2025a comment lines before markdown conversion (no-op for binary.mlxtext content, which is already clean)live_script.html.jinjatemplate iterateslive_script.sections, rendering"text"sections viaconvert_markdownand"code"sections viahighlight(language="matlab")AutorefsHook.get_context()handles thelive_scriptobject kindUsage