mkdocstrings-matlab 2.1.0__tar.gz → 2.1.2__tar.gz

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/.github/workflows/docs.yaml

@@ -30,15 +30,15 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/configure-pages@v5
+      - uses: actions/configure-pages@v6
 
-      - uses: actions/checkout@v6
+      - uses: actions/checkout@v7
         with:
           fetch-depth: 0 # Required to push to the documentation branch
           ref: ${{ inputs.ref }}
 
       - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v10.2.0
         with:
           version: "latest"
 
@@ -54,11 +54,11 @@ jobs:
           uv sync --no-dev --group mkdocs
           uv run mkdocs build --clean
 
-      - uses: actions/upload-pages-artifact@v4
+      - uses: actions/upload-pages-artifact@v5
         if: ${{ inputs.push }}
         with:
           path: site
 
-      - uses: actions/deploy-pages@v4
+      - uses: actions/deploy-pages@v5
         if: ${{ inputs.push }}
         id: deployment

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/.github/workflows/qualify.yaml

@@ -43,7 +43,7 @@ jobs:
       python-versions: ${{ steps.get-versions.outputs.python-versions }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
 
       - name: Get Python versions from pyproject.toml
         id: get-versions
@@ -70,16 +70,16 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
 
       - name: Set up uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v10.2.0
         with:
           version: "latest"
 
       - name: Cache uv
         id: cache-uv
-        uses: actions/cache@v5
+        uses: actions/cache@v6
         with:
           path: .venv
           key: ${{ runner.os }}-qualify-uv-${{ matrix.python-version }}-${{ matrix.resolution }}-${{ github.head_ref || github.ref_name }}-${{ hashFiles('pyproject.toml') }}
@@ -156,7 +156,7 @@ jobs:
       pull-requests: write
     steps:
       - name: Checkout
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           fetch-depth: 2
 
@@ -171,7 +171,7 @@ jobs:
           files: "results/**/pytest.xml"
 
       - name: Upload coverage reports to Codecov
-        uses: codecov/codecov-action@v5
+        uses: codecov/codecov-action@v7
         with:
           use_oidc: true
           directory: results

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/.github/workflows/release.yaml

@@ -23,7 +23,7 @@ jobs:
       version: ${{ steps.get-version.outputs.version }}
     steps:
       - name: Get semantic version
-        uses: RonaldPhilipsen/semVersie@v2.1.0
+        uses: RonaldPhilipsen/semVersie@v2.3.4
         id: get-version
         with:
           add-pr-label: true
@@ -49,12 +49,12 @@ jobs:
           private-key: ${{ secrets.APP_PRIVATE_KEY }}
 
       - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v7
+        uses: astral-sh/setup-uv@v10.2.0
         with:
           version: "latest"
 
       - name: Checkout repository
-        uses: actions/checkout@v6
+        uses: actions/checkout@v7
         with:
           token: ${{ steps.app-token.outputs.token }}
 

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/.gitignore

@@ -141,6 +141,9 @@ venv.bak/
 # mkdocs documentation
 /site
 
+# inline-snapshot
+test/snapshots/files_using_external.txt
+
 # mypy
 .mypy_cache/
 .dmypy.json

mkdocstrings_matlab-2.1.2/.rumdl.toml

@@ -0,0 +1,72 @@
+# rumdl configuration file
+
+# Inherit settings from another config file (relative to this file's directory)
+# extends = "../base.rumdl.toml"
+
+# Global configuration options
+[global]
+
+flavor = "mkdocs"
+
+# List of rules to disable (uncomment and modify as needed)
+disable = ["MD013", "MD033", "MD041"]
+
+# List of rules to enable exclusively (replaces defaults; only these rules will run)
+# enable = ["MD001", "MD003", "MD004"]
+
+# Additional rules to enable on top of defaults (additive, does not replace)
+# Use this to activate opt-in rules like MD060, MD063, MD072, MD073, MD074
+# extend-enable = ["MD060", "MD063"]
+
+# Additional rules to disable on top of the disable list (additive)
+# extend-disable = ["MD041"]
+
+# List of file/directory patterns to include for linting (if provided, only these will be linted)
+# include = [
+#    "docs/*.md",
+#    "src/**/*.md",
+#    "README.md"
+# ]
+
+# List of file/directory patterns to exclude from linting
+exclude = [
+    # Common directories to exclude
+    ".git",
+    ".github",
+    "node_modules",
+    "vendor",
+    "dist",
+    "build",
+
+    # Specific files or patterns
+    "CHANGELOG.md",
+    "LICENSE.md",
+]
+
+# Respect .gitignore files when scanning directories (default: true)
+respect-gitignore = true
+
+# Markdown flavor/dialect (uncomment to enable)
+# Options: standard (default), gfm, commonmark, mkdocs, mdx, pandoc, quarto, obsidian, kramdown, azure_devops, myst, mdg
+# flavor = "mkdocs"
+
+# Rule-specific configurations (uncomment and modify as needed)
+
+# [MD003]
+# style = "atx"  # Heading style (atx, atx_closed, setext)
+
+# [MD004]
+# style = "asterisk"  # Unordered list style (asterisk, plus, dash, consistent)
+
+# [MD007]
+# indent = 4  # Unordered list indentation
+
+# [MD013]
+# line-length = 100  # Line length
+# code-blocks = false  # Exclude code blocks from line length check
+# tables = false  # Exclude tables from line length check
+# headings = true  # Include headings in line length check
+
+# [MD044]
+# names = ["rumdl", "Markdown", "GitHub"]  # Proper names that should be capitalized correctly
+# code-blocks = false  # Check code blocks for proper names (default: false, skips code blocks)

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: mkdocstrings-matlab
-Version: 2.1.0
+Version: 2.1.2
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -23,7 +23,7 @@ Classifier: Typing :: Typed
 Requires-Python: <3.15,>=3.10
 Requires-Dist: charset-normalizer<4,>=3.4
 Requires-Dist: griffe<3,>=2.0.0
-Requires-Dist: maxx<1,>=0.8.0
+Requires-Dist: maxx<1,>=0.10.0
 Requires-Dist: mkdocs-autorefs<2,>=1.4
 Requires-Dist: mkdocstrings<2,>=1.0
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'
@@ -33,7 +33,7 @@ Description-Content-Type: text/markdown
 
 <h1 align="center">mkdocstrings-matlab</h1>
 
-<p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
+<p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>,</br>compatible with <a href="https://squidfunk.github.io/mkdocs-material">Material for MkDocs</a> and <a href="https://zensical.org/about/">Zensical</a>.</p>
 
 <p align="center"><img width=300px src="logo.png"></p>
 
@@ -42,6 +42,8 @@ Description-Content-Type: text/markdown
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
 [![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-matlab/graph/badge.svg?token=T2csKmj2o2)](https://codecov.io/github/watermarkhu/mkdocstrings-matlab)
 
+**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](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).
 
 You can install this handler by specifying it as a dependency:
@@ -62,6 +64,8 @@ To get started, checkout the [📝 documentation](https://watermarkhu.github.io/
 
 ## Features
 
+- Compatible with both [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material) and [Zensical](https://zensical.org/about/).
+
 - 🤖 **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
   [Tree-sitter](https://tree-sitter.github.io/tree-sitter/).
 

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/README.md

@@ -2,7 +2,7 @@
 
 <h1 align="center">mkdocstrings-matlab</h1>
 
-<p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
+<p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>,</br>compatible with <a href="https://squidfunk.github.io/mkdocs-material">Material for MkDocs</a> and <a href="https://zensical.org/about/">Zensical</a>.</p>
 
 <p align="center"><img width=300px src="logo.png"></p>
 
@@ -11,6 +11,8 @@
 [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
 [![codecov](https://codecov.io/github/watermarkhu/mkdocstrings-matlab/graph/badge.svg?token=T2csKmj2o2)](https://codecov.io/github/watermarkhu/mkdocstrings-matlab)
 
+**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](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).
 
 You can install this handler by specifying it as a dependency:
@@ -31,6 +33,8 @@ To get started, checkout the [📝 documentation](https://watermarkhu.github.io/
 
 ## Features
 
+- Compatible with both [Material for Mkdocs](https://squidfunk.github.io/mkdocs-material) and [Zensical](https://zensical.org/about/).
+
 - 🤖 **Data collection from source code**: collection of the object-tree and the docstrings is done thanks to
   [Tree-sitter](https://tree-sitter.github.io/tree-sitter/).
 

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/docs/api.md

@@ -11,4 +11,3 @@
       members:
         - handler
         - config
-

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/docs/index.md

@@ -5,7 +5,7 @@ hide:
 
 --8<-- "README.md:header"
 
-## Preview 
+## Preview
 
 Let's us quickly see how auto-documentation works with mkdocstrings-matlab:
 
@@ -38,10 +38,10 @@ Given the function above, the rendered documentation here is created from the fo
 
 !!! note
 
-    Syntax highlighting of argument blocks will be incorrect with the default configuration due to the outdated MATLAB lexer in [Pygments](https://github.com/pygments/pygments/) and will be resolved after [our PR](https://github.com/pygments/pygments/pull/2887) is merged. 
+    Syntax highlighting of argument blocks will be incorrect with the default configuration due to the outdated MATLAB lexer in [Pygments](https://github.com/pygments/pygments/) and will be resolved after [our PR](https://github.com/pygments/pygments/pull/2887) is merged.
 
     In the meantime, the correct syntax highlighing can be configured by adding our branch as the dependency in `pyproject.toml`
-    
+
     ```toml title="pyproject.toml"
     dependencies = [
         "pygments @ git+https://github.com/watermarkhu/pygments.git@matlab",

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/docs/license-page.md

@@ -7,6 +7,6 @@ hide:
 
 # License
 
-```
+```text
 --8<-- "LICENSE"
 ```

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+module/module.md

@@ -23,7 +23,7 @@
         ```matlab
         --8<-- "docs/src/snippets/+module/do_something.m"
         ```
-    
+
     === ":material-file-code: `aClass.m`"
 
         ```matlab
@@ -40,4 +40,4 @@
 
         ```matlab
         --8<-- "docs/src/snippets/+module/+submodule/Contents.m"
-        ```
+        ```

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mymembers/mymembers.md

@@ -15,7 +15,7 @@
         ```matlab
         --8<-- "docs/src/snippets/+mymembers/Contents.m"
         ```
-    
+
     === ":material-file-code: `ThisClass.m`"
 
         ```matlab
@@ -32,4 +32,4 @@
 
         ```matlab
         --8<-- "docs/src/snippets/+mymembers/this_function.m"
-        ```
+        ```

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+mynamespace/mynamespace.md

@@ -8,6 +8,7 @@
             classA.m
             classB.m
             typed_function.m
+            typed_class_property.m
             myscript.m
         ```
 
@@ -22,7 +23,7 @@
         ```matlab
         --8<-- "docs/src/snippets/+mynamespace/classA.m"
         ```
-    
+
     === ":material-file-code: `classB.m`"
 
         ```matlab
@@ -35,6 +36,12 @@
         --8<-- "docs/src/snippets/+mynamespace/typed_function.m"
         ```
 
+    === ":material-file-code: `typed_class_property.m`"
+
+        ```matlab
+        --8<-- "docs/src/snippets/+mynamespace/typed_class_property.m"
+        ```
+
     === ":material-file-code: `myscript.m`"
 
         ```matlab

mkdocstrings_matlab-2.1.2/docs/src/snippets/+mynamespace/readme.md

@@ -0,0 +1 @@
+This is the docstring for mynamespace.

mkdocstrings_matlab-2.1.2/docs/src/snippets/+mynamespace/typed_class_property.m

@@ -0,0 +1,17 @@
+function output = typed_class_property(opts)
+    % Example function with name-value arguments from a class property.
+    %
+    % # Examples
+    %
+    % ```matlab
+    % output = typed_class_property();
+    % ```
+    arguments (Input)
+        opts.?mynamespace.classA
+            % Name-value arguments matching the properties of `classA`.
+    end
+    arguments (Output)
+        output (1,:) char % The output variable
+    end
+    output = char(1);
+end

{mkdocstrings_matlab-2.1.0 → mkdocstrings_matlab-2.1.2}/docs/src/snippets/+undocumented/undocumented.md

@@ -14,7 +14,7 @@
         ```matlab
         --8<-- "docs/src/snippets/+undocumented/ClassWithoutDocstring.m"
         ```
-    
+
     === ":material-file-code: `function_with_docstring.m`"
 
         ```matlab