mkdocstrings-matlab 1.0.6__tar.gz → 1.0.8__tar.gz

mkdocstrings_matlab-1.0.8/.github/CONTRIBUTING.md

@@ -0,0 +1,40 @@
+# Contributing to mkdocstrings-matlab
+
+Thank you for considering contributing! Please follow these steps to get started:
+
+## 1. Environment Setup
+
+Install all dependencies using [uv](https://github.com/astral-sh/uv):
+
+```sh
+uv sync --all-groups
+```
+
+Learn more about uv: [uv documentation](https://github.com/astral-sh/uv)
+
+## 2. Pre-commit Hooks using prek
+
+Set up [prek](https://github.com/j178/prek) hooks to ensure code quality:
+
+```sh
+uv run prek install
+```
+
+See: [prek documentation](https://prek.j178.dev/)
+
+## 3. Running Tests
+
+Run tests with [pytest](https://docs.pytest.org/en/stable/):
+
+```sh
+uv run pytest
+```
+
+See: [pytest documentation](https://docs.pytest.org/en/stable/)
+
+## 4. Pull Request Guidelines
+
+- Pull requests should target the `main` branch.
+- Use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages.
+
+See: [Conventional Commits Spec](https://www.conventionalcommits.org/en/v1.0.0/)

mkdocstrings_matlab-1.0.8/.github/renovate.json5

@@ -0,0 +1,87 @@
+{
+  $schema: "https://docs.renovatebot.com/renovate-schema.json",
+  extends: [
+    "config:recommended",
+  ],
+  automerge: true,
+  semanticCommits: "enabled",
+  branchPrefix: "renovate-",
+  packageRules: [
+    {
+      groupName: "group-github-actions",
+      description: "Group GitHub Action updates",
+      matchManagers: [
+        "github-actions",
+      ],
+      semanticCommitType: "ci",
+      semanticCommitScope: "deps",
+    },
+    {
+      groupName: "group-pre-commit",
+      description: "Group pre-commit hook updates",
+      matchManagers: [
+        "pre-commit",
+      ],
+      semanticCommitType: "build",
+      semanticCommitScope: "deps",
+    },
+    {
+      // This handles all non-dev, non-doc dependencies in pyproject.toml
+      groupName: "group-pyproject",
+      description: "Group dependency updates from pyproject.toml",
+      matchFileNames: [
+        "pyproject.toml",
+      ],
+      semanticCommitType: "chore",
+      semanticCommitScope: "deps",
+    },
+    {
+      // This handles dev dependencies in pyproject.toml
+      groupName: "group-pyproject-dev",
+      description: "Group dev dependency updates from pyproject.toml",
+      matchFileNames: [
+        "pyproject.toml",
+      ],
+      matchPackageNames: [
+        "ty",
+        "prek",
+        "ruff",
+        "pydantic",
+        "pytest",
+        "pytest-cov",
+        "beautifulsoup4",
+        "inline-snapshot",
+        "python-semantic-release",
+      ],
+      semanticCommitType: "build",
+      semanticCommitScope: "deps",
+    },
+    {
+      // This handles documentation-related dependencies in pyproject.toml
+      groupName: "group-pyproject-docs",
+      description: "Group docs dependency updates from pyproject.toml",
+      matchFileNames: [
+        "pyproject.toml",
+      ],
+      matchPackageNames: [
+        "pygments",
+        "mkdocs-material",
+        "mkdocstrings-python",
+        "markdown-exec",
+        "mkdocs-callouts",
+        "mkdocs-git-revision-date-localized-plugin",
+        "mkdocs-minify-plugin",
+        "mike",
+      ],
+      semanticCommitType: "docs",
+      semanticCommitScope: "deps",
+    },
+  ],
+  "pre-commit": {
+    enabled: true,
+  },
+  // Disable poetry and let the PEP621 manager handle pyproject.toml
+  "poetry": {
+    "enabled": false
+  }
+}

{mkdocstrings_matlab-1.0.6 → mkdocstrings_matlab-1.0.8}/.github/workflows/release.yaml

@@ -14,9 +14,11 @@ jobs:
   release:
     name: Semantic version release
     runs-on: ubuntu-latest
+    permissions:
+      pull-requests: write
     outputs:
-      released: ${{ steps.semantic-release.outputs.released }}
-      tag: ${{ steps.semantic-release.outputs.tag }}
+      released: ${{ steps.get-version.outputs.released == 'true' }}
+      next-tag: ${{ steps.get-version.outputs.next-tag }}
 
     steps:
     - uses: actions/create-github-app-token@v2
@@ -47,27 +49,33 @@ jobs:
       run: |
         git checkout -B ${{ github.ref_name }} ${{ github.sha }}
 
-    - name: Update version and changelogs
-      id: semantic-release
-      uses: python-semantic-release/python-semantic-release@v10
-      with: 
-        build: false
-        changelog: true
-        commit: true
-        push: true
-        tag: true
-        vcs_release: true
-        github_token: ${{ steps.app-token.outputs.token }}
-        no_operation_mode: ${{ !github.event.pull_request.merged }}
-
-  comment:
-    name: Create or update comment
-    if: github.event.pull_request.merged == false
-    needs: release
-    runs-on: ubuntu-latest
-    permissions:
-      pull-requests: write
-    steps:
+    - name: Set up uv
+      uses: astral-sh/setup-uv@v6
+      with:
+        version: "latest"
+
+    - name: Install dependencies
+      shell: bash
+      run: |
+        uv sync --all-groups
+
+    - name: Get check version
+      id: get-version
+      shell: bash
+      env:
+        GH_TOKEN: ${{ steps.app-token.outputs.token }}
+      run: |
+        LAST_TAG=$(uv run semantic-release --noop version --print-last-released-tag)
+        NEXT_TAG=$(uv run semantic-release --noop version --print-tag)
+        if [ "$LAST_TAG" == "$NEXT_TAG" ] || [ -z "$NEXT_TAG" ]; then
+          RELEASED=false
+        else
+          RELEASED=true
+        fi
+        echo "last-tag=$LAST_TAG" >> $GITHUB_OUTPUT
+        echo "next-tag=$NEXT_TAG" >> $GITHUB_OUTPUT
+        echo "released=$RELEASED" >> $GITHUB_OUTPUT
+
     - name: Find Comment
       id: fc
       uses: peter-evans/find-comment@v3
@@ -77,24 +85,32 @@ jobs:
         body-includes: This comment was written by a bot!
 
     - name: Create comment
-      if: steps.fc.outputs.comment-id == ''
+      if: steps.fc.outputs.comment-id == '' && steps.get-version.outputs.released == 'true' 
       uses: peter-evans/create-or-update-comment@v4
       with:
         issue-number: ${{ github.event.pull_request.number }}
         body: |
-          Next release: `${{ needs.release.outputs.tag }}`
+          Next release: `${{ steps.get-version.outputs.next-tag }}`
           <!-- This comment was written by a bot! -->
           
     - name: Update comment
-      if: steps.fc.outputs.comment-id != ''
+      if: steps.fc.outputs.comment-id != '' && steps.get-version.outputs.released == 'true' 
       uses: peter-evans/create-or-update-comment@v4
       with:
         comment-id: ${{ steps.fc.outputs.comment-id }}
         edit-mode: replace
         body: |
-          Next release: `${{ needs.release.outputs.tag }}`
+          Next release: `${{ steps.get-version.outputs.next-tag }}`
           <!-- This comment was written by a bot! -->
 
+    - name: Create release
+      if: github.event.pull_request.merged && steps.get-version.outputs.released == 'true'
+      shell: bash
+      env:
+        GH_TOKEN: ${{ steps.app-token.outputs.token }}
+      run: |
+        uv run semantic-release -v version --commit --tag --push --changelog --vcs-release --skip-build
+
   deploy: 
     name: Deploy package distributions
     needs: release
@@ -108,7 +124,7 @@ jobs:
     - name: Checkout repository
       uses: actions/checkout@v5
       with:
-        ref: ${{ needs.release.outputs.tag }}
+        ref: ${{ needs.release.outputs.next-tag }}
 
     - name: Install the latest version of uv
       uses: astral-sh/setup-uv@v6
@@ -125,7 +141,7 @@ jobs:
       id: publish-dist
       uses: softprops/action-gh-release@v2
       with:
-        tag_name: ${{ needs.release.outputs.tag }}
+        tag_name: ${{ needs.release.outputs.next-tag }}
         files: |
           dist/*.whl
           dist/*.tar.gz
@@ -183,8 +199,8 @@ jobs:
       contents: write
     secrets: inherit
     with:
-      version: ${{ needs.release.outputs.tag }}
+      version: ${{ needs.release.outputs.next-tag }}
       alias: latest
       set-default: true
-      ref: ${{ needs.release.outputs.tag }}
+      ref: ${{ needs.release.outputs.next-tag }}
       push: true

mkdocstrings_matlab-1.0.8/.pre-commit-config.yaml

@@ -0,0 +1,36 @@
+fail_fast: false
+
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: check-merge-conflict
+
+  - repo: https://github.com/abravalheri/validate-pyproject
+    rev: v0.24.1
+    hooks:
+      - id: validate-pyproject
+
+  - repo: local
+    hooks:
+      - id: uv
+        name: uv-lock
+        entry: uv lock
+        language: python
+        files: ^(uv\.lock|pyproject\.toml|uv\.toml)$
+        pass_filenames: false
+      - id: ruff-check
+        name: ruff check
+        entry: uv run ruff check --fix --exit-non-zero-on-fix
+        language: python
+        types_or: [python, pyi, jupyter]
+      - id: ruff-format
+        name: ruff format
+        entry: uv run ruff format --force-exclude
+        language: python
+        types_or: [python, pyi, jupyter]
+      - id: ty
+        name: ty check
+        entry: uv run ty check . --ignore unresolved-import
+        language: python
+        types_or: [python, pyi, jupyter]

{mkdocstrings_matlab-1.0.6 → mkdocstrings_matlab-1.0.8}/CHANGELOG.md

@@ -1,6 +1,15 @@
 # CHANGELOG
 
 
+## v1.0.7 (2025-09-17)
+
+### Chores
+
+- **deps**: Update group-pyproject-toml
+  ([#102](https://github.com/watermarkhu/mkdocstrings-matlab/pull/102),
+  [`2271a6d`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/2271a6ddf73a2fe9ba6b7c58368f4e00a8b49365))
+
+
 ## v1.0.6 (2025-08-29)
 
 ### Chores

{mkdocstrings_matlab-1.0.6 → mkdocstrings_matlab-1.0.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 1.0.6
+Version: 1.0.8
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -21,8 +21,8 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: <3.14,>=3.10
 Requires-Dist: charset-normalizer~=3.4
-Requires-Dist: griffe~=1.13.0
-Requires-Dist: maxx~=0.3.0
+Requires-Dist: griffe~=1.14.0
+Requires-Dist: maxx~=0.4.2
 Requires-Dist: mkdocs-autorefs~=1.4
 Requires-Dist: mkdocstrings~=0.29
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'

mkdocstrings_matlab-1.0.8/docs/contributing.md

@@ -0,0 +1 @@
+--8<-- ".github/CONTRIBUTING.md"

mkdocstrings_matlab-1.0.8/docs/license-page.md

@@ -0,0 +1,12 @@
+---
+hide:
+- feedback
+---
+
+<!-- This page is named license-page such that it won't show in the GitHub UI -->
+
+# License
+
+```
+--8<-- "LICENSE"
+```

{mkdocstrings_matlab-1.0.6 → mkdocstrings_matlab-1.0.8}/mkdocs.yml

@@ -4,7 +4,7 @@ site_url: "https://watermarkhu.nl/mkdocstrings-matlab"
 repo_url: "https://github.com/watermarkhu/mkdocstrings-matlab"
 repo_name: "watermarkhu/mkdocstrings-matlab"
 watch: [mkdocs.yml, README.md, src/mkdocstrings_handlers]
-copyright: Copyright © 2024 Mark Shui Hu
+copyright: Copyright © 2025 Mark Shui Hu
 edit_uri: edit/main/docs/
 
 validation:
@@ -16,8 +16,9 @@ nav:
 - Home:
   - Overview: index.md
   - Changelog: changelog.md
+  - Contributing: contributing.md
   - Credits: credits.md
-  - License: license.md
+  - License: license-page.md
 - Usage:
   - usage/index.md
   - Configuration options:

{mkdocstrings_matlab-1.0.6 → mkdocstrings_matlab-1.0.8}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "1.0.6"
+version = "1.0.8"
 description = "A MATLAB handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -26,8 +26,8 @@ classifiers = [
 ]
 
 dependencies = [
-    "griffe~=1.13.0",
-    "maxx~=0.3.0",
+    "griffe~=1.14.0",
+    "maxx~=0.4.2",
     "mkdocstrings~=0.29",
     "mkdocs-autorefs~=1.4",
     "charset-normalizer~=3.4",
@@ -39,14 +39,15 @@ pygments = { git = "https://github.com/watermarkhu/pygments", branch = "matlab"
 
 [dependency-groups]
 dev = [
-    "pre-commit",
     "ty~=0.0.1a19",
-    "ruff~=0.12.9",
+    "prek>=0.2.1",
+    "ruff~=0.13.1",
     "pydantic~=2.10",
     "pytest~=8.4.1",
-    "pytest-cov~=6.2.1",
-    "inline-snapshot~=0.27.2",
-    "python-semantic-release~=10.3.0",
+    "pytest-cov~=7.0.0",
+    "beautifulsoup4>=4.13.3",
+    "inline-snapshot~=0.29.1",
+    "python-semantic-release~=10.4.1",
 ]
 docs = [
     "pygments",
@@ -58,9 +59,6 @@ docs = [
     "mkdocs-minify-plugin~=0.8",
     "mike~=2.1",
 ]
-reference = [
-    "beautifulsoup4>=4.13.3",
-]
 
 [build-system]
 requires = ["hatchling"]
@@ -91,8 +89,10 @@ quote-style = "double"
 indent-style = "space"
 
 [tool.inline-snapshot]
+test-dir = "test"
 storage-dir = "test/snapshots"
 format-command = "ruff format --config pyproject.toml --stdin-filename {filename}"
+default-flags=["create", "fix", "trim"]
 
 [tool.ty.src]
 include = ["src", "pyproject.toml"]
@@ -121,41 +121,8 @@ match = "(?s).*"
 prerelease_token = "rc"
 prerelease = false
 
-[tool.semantic_release.changelog]
-exclude_commit_patterns = []
-mode = "init"
-insertion_flag = "<!-- version list -->"
-template_dir = "templates"
-
-[tool.semantic_release.changelog.default_templates]
-changelog_file = "CHANGELOG.md"
-output_format = "md"
-mask_initial_release = false
-
-[tool.semantic_release.changelog.environment]
-block_start_string = "{%"
-block_end_string = "%}"
-variable_start_string = "{{"
-variable_end_string = "}}"
-comment_start_string = "{#"
-comment_end_string = "#}"
-trim_blocks = false
-lstrip_blocks = false
-newline_sequence = "\n"
-keep_trailing_newline = false
-extensions = []
-autoescape = false
-
-[tool.semantic_release.commit_author]
-env = "GIT_COMMIT_AUTHOR"
-default = "semantic-release <semantic-release>"
-
 [tool.semantic_release.commit_parser_options]
-minor_tags = ["feat", "enhancement", "improvement", "new"]
-patch_tags = ["fix", "perf", "patch", "chore"]
-other_allowed_tags = ["build", "ci", "docs", "style", "refactor", "test"]
-allowed_tags = ["feat", "fix", "perf", "build", "chore", "ci", "docs", "style", "refactor", "test"]
-default_bump_level = 0
+patch_tags = ["fix", "perf", "chore"]
 
 [tool.pytest.ini_options]
 pythonpath = [

{mkdocstrings_matlab-1.0.6 → mkdocstrings_matlab-1.0.8}/src/mkdocstrings_handlers/matlab/config.py

@@ -358,10 +358,10 @@ class MatlabInputOptions:
     ] = "table"
 
     docstring_style: Annotated[
-        Literal["auto", "google", "numpy", "sphinx"] | None,
+        Literal["google", "numpy", "sphinx"] | None,
         Field(
             group="docstrings",
-            description="The docstring style to use: `auto`, `google`, `numpy`, `sphinx`, or `None`.",
+            description="The docstring style to use: `google`, `numpy`, `sphinx`, or `None`.",
         ),
     ] = "google"
 

{mkdocstrings_matlab-1.0.6 → mkdocstrings_matlab-1.0.8}/src/mkdocstrings_handlers/matlab/handler.py

@@ -132,6 +132,9 @@ class MatlabHandler(BaseHandler):
         template_name = rendering.do_get_template(data)
         template = self.env.get_template(template_name)
 
+        if hasattr(data, "docstring") and data.docstring is not None:
+            data.docstring.parse()
+
         heading_level = options.heading_level
 
         html = template.render(

{mkdocstrings_matlab-1.0.6 → mkdocstrings_matlab-1.0.8}/test/conftest.py

@@ -141,3 +141,11 @@ def session_handler(
     handler = helpers.handler(session_plugin, session_ext_markdown)
     yield handler
     assert len(handler.env.filters["stash_crossref"].stash) == 0
+
+
+@pytest.fixture(autouse=True)
+def disable_cached_property(monkeypatch):
+    def identity(x):
+        return x
+
+    monkeypatch.setattr("functools.cached_property", identity)

mkdocstrings_matlab-1.0.8/test/fixture/forced_docstring.m

@@ -0,0 +1,11 @@
+function outputs = forced_docstring(inputA, inputB)
+% Docstring for forced_docstring.
+%
+% Arguments:
+%   inputA (double): First input parameter
+%   inputB (string): Second input parameter
+%
+% Outputs:
+%   outputs (struct): A structure containing the results
+
+end