Skip to content

Commit af0a298

Browse files
watermarkhuCopilotCopilot
authored
docs: new descriptive first paragraph (#173)
* docs: new descriptive first paragraph * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * fix: suppress ty type error for existing_template test assignment Agent-Logs-Url: https://github.com/watermarkhu/mkdocstrings-matlab/sessions/46e83275-0326-4271-8f5c-f651086c45eb Co-authored-by: watermarkhu <18556882+watermarkhu@users.noreply.github.com> --------- Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
1 parent 0664be9 commit af0a298

2 files changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
[![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
1212
[![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-matlab/graph/badge.svg?token=T2csKmj2o2)](https://codecov.io/github/watermarkhu/mkdocstrings-matlab)
1313

14+
**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.
15+
1416
The MATLAB handler uses [maxx](https://github.com/watermarkhu/maxx) to collect documentation from MATLAB source code, which in turn uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab).
1517

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

src/mkdocstrings_handlers/matlab/handler.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ def update_env(self, config: Any) -> None: # noqa: ARG002
203203
rendering.do_as_inheritance_diagram_section
204204
)
205205
self.env.globals["AutorefsHook"] = rendering.AutorefsHook # ty: ignore[invalid-assignment]
206-
self.env.tests["existing_template"] = lambda template_name: (
206+
self.env.tests["existing_template"] = lambda template_name: ( # ty: ignore[invalid-assignment]
207207
template_name in self.env.list_templates()
208208
)
209209
# The following is required since in MATLAB there is a concept called namespace

0 commit comments

Comments
 (0)