mkdocstrings-matlab 0.9.1__tar.gz → 0.9.3__tar.gz

{mkdocstrings_matlab-0.9.1 → mkdocstrings_matlab-0.9.3}/.github/workflows/docs.yaml

@@ -19,6 +19,11 @@ on:
           Set the alias as the default version
         type: boolean
         default: true
+      ref:
+        description: >-
+          The ref to checkout and use to create docs
+        type: string
+        default: ""
       push:
         description: >-
           Push the documentation to the remote branch
@@ -36,6 +41,7 @@ jobs:
       - uses: actions/checkout@v4
         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@v5

{mkdocstrings_matlab-0.9.1 → mkdocstrings_matlab-0.9.3}/.github/workflows/qualify.yaml

@@ -20,7 +20,7 @@ permissions:
 
 jobs:
   docs:
-    if: github.event.pull_request.draft == false
+    if: contains(github.event.pull_request.labels.*.name, 'documentation')
     name: Test deploy documentation
     uses: ./.github/workflows/docs.yaml
     concurrency:
@@ -35,6 +35,7 @@ jobs:
 
   check-semantic-version:
     name: Check semantic version
+    if: github.repository == 'watermarkhu/mkdocstrings-matlab'
     runs-on: ubuntu-latest
     steps:
 

{mkdocstrings_matlab-0.9.1 → mkdocstrings_matlab-0.9.3}/.github/workflows/release.yaml

@@ -10,6 +10,46 @@ permissions:
   id-token: write
 
 jobs:
+  delete-test-document:
+    name: Delete test documentation
+    runs-on: ubuntu-latest
+    if: contains( github.event.pull_request.labels.*.name, 'documentation')
+    concurrency:
+      group: gh-pages
+      cancel-in-progress: false
+
+    steps:
+      - name: checkout repository
+        uses: actions/checkout@v4
+        with: 
+          fetch-depth: 0 # Required to push to the documentation branch
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          version: "latest"
+
+      - name: Sync dependencies
+        run: |
+          uv sync --no-dev --group docs
+
+      - name: Configure Git Credentials
+        run: |
+          git config --global user.name github-actions[bot]
+          git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
+          git fetch origin gh-pages:gh-pages
+  
+      - name: delete testing documentation
+        continue-on-error: true
+        env:
+          VERSION: ${{ format('pr-{0}', github.head_ref) || 'test' }}
+        run: >
+          uv run mike delete 
+          --push --ignore-remote-status 
+          --config-file mkdocs.yml
+          --branch gh-pages
+          $VERSION
+
   publish:
     if: github.event.pull_request.merged == true
     name: Semantic version release
@@ -55,7 +95,7 @@ jobs:
 
     - name: Update version and changelogs
       id: semantic-release
-      uses: python-semantic-release/python-semantic-release@v9.16.1
+      uses: python-semantic-release/python-semantic-release@v9.17.0
       with: 
         build: false
         changelog: true
@@ -81,58 +121,20 @@ jobs:
     - name: Publish package distributions to GitHub Releases
       if: steps.semantic-release.outputs.released == 'true'
       id: publish-dist
-      uses: python-semantic-release/publish-action@v9.16.1
+      uses: python-semantic-release/publish-action@v9.17.0
       with:
         github_token: ${{ steps.app-token.outputs.token }}
         tag: ${{ steps.semantic-release.outputs.tag }}
 
-  delete-test-document:
-    name: Delete test documentation
-    needs: publish
-    runs-on: ubuntu-latest
-    concurrency:
-      group: gh-pages
-      cancel-in-progress: false
-
-    steps:
-      - name: checkout repository
-        uses: actions/checkout@v4
-        with: 
-          fetch-depth: 0 # Required to push to the documentation branch
-
-      - name: Install the latest version of uv
-        uses: astral-sh/setup-uv@v5
-        with:
-          version: "latest"
-
-      - name: Sync dependencies
-        run: |
-          uv sync --no-dev --group docs
-
-      - name: Configure Git Credentials
-        run: |
-          git config --global user.name github-actions[bot]
-          git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
-          git fetch origin gh-pages:gh-pages
-  
-      - name: delete testing documentation
-        continue-on-error: true
-        env:
-          VERSION: ${{ format('pr-{0}', github.head_ref) || 'test' }}
-        run: >
-          uv run mike delete 
-          --push --ignore-remote-status 
-          --config-file mkdocs.yml
-          --branch gh-pages
-          $VERSION
-
   mkdocs:
     name: Deploy documentation
     needs: [publish, delete-test-document]
+    if: ${{ always() && !failure() && !cancelled() }}
     uses: ./.github/workflows/docs.yaml
     secrets: inherit
     with:
       version: ${{ needs.publish.outputs.tag }}
       alias: latest
       set-default: true
+      ref: ${{ needs.publish.outputs.tag }}
       push: true

{mkdocstrings_matlab-0.9.1 → mkdocstrings_matlab-0.9.3}/CHANGELOG.md

@@ -1,6 +1,53 @@
 # CHANGELOG
 
 
+## v0.9.3 (2025-01-29)
+
+### Bug Fixes
+
+- Ignore `%#codegen` compilation directive
+  ([#61](https://github.com/watermarkhu/mkdocstrings-matlab/pull/61),
+  [`7239847`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/72398479b347ed778c516e4e1fdad6ab8b6ccdc1))
+
+* fix: Ignore `%#codegen` compilation directive
+
+* Exclude all pragmas instead of only %#codegen
+
+Co-authored-by: Mark Shui Hu <watermarkhu@gmail.com>
+
+---------
+
+### Chores
+
+- Make sure that release documentation is using the new version
+  ([#60](https://github.com/watermarkhu/mkdocstrings-matlab/pull/60),
+  [`c3a9899`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/c3a9899a9b3c031a72880df1b50b09b28206890f))
+
+* Update docs.yaml
+
+* Update release.yaml
+
+* Update qualify.yaml
+
+
+## v0.9.2 (2025-01-26)
+
+### Bug Fixes
+
+- **deps**: Update deps ([#59](https://github.com/watermarkhu/mkdocstrings-matlab/pull/59),
+  [`131c30c`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/131c30ca6046a85def35f37f5f2a3d48e9815f2d))
+
+* chore(deps): update python-semantic-release/python-semantic-release action to v9.17.0 (#55)
+
+Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
+
+* chore(deps): update python-semantic-release/publish-action action to v9.17.0 (#54)
+
+* fix(deps): update dependency tree-sitter to v0.24.0 (#53)
+
+---------
+
+
 ## v0.9.1 (2025-01-16)
 
 ### Bug Fixes

{mkdocstrings_matlab-0.9.1 → mkdocstrings_matlab-0.9.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.9.1
+Version: 0.9.3
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -25,7 +25,7 @@ Requires-Dist: charset-normalizer==3.4.1
 Requires-Dist: mkdocstrings-python==1.13.0
 Requires-Dist: mkdocstrings==0.27.0
 Requires-Dist: tree-sitter-matlab==1.0.3
-Requires-Dist: tree-sitter==0.23.2
+Requires-Dist: tree-sitter==0.24.0
 Description-Content-Type: text/markdown
 
 <!-- --8<-- [start:header] -->

{mkdocstrings_matlab-0.9.1 → mkdocstrings_matlab-0.9.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "mkdocstrings-matlab"
-version = "0.9.1"
+version = "0.9.3"
 description = "A MATLAB handler for mkdocstrings"
 authors = [
     { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -12,7 +12,7 @@ dependencies = [
     "mkdocstrings==0.27.0",
     "mkdocstrings-python==1.13.0",
     "charset-normalizer==3.4.1",
-    "tree-sitter==0.23.2",
+    "tree-sitter==0.24.0",
     "tree-sitter-matlab==1.0.3",
 ]
 classifiers = [

mkdocstrings_matlab-0.9.3/renovate.json

@@ -0,0 +1,13 @@
+{
+    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+    "extends": [
+        "config:recommended"
+    ],
+    "branchPrefix": "renovate-", 
+    "packageRules": [
+        {
+          "description": "Group GitHub Action updates",
+          "matchManagers": ["github-actions"]
+        }
+    ]
+}

{mkdocstrings_matlab-0.9.1 → mkdocstrings_matlab-0.9.3}/src/mkdocstrings_handlers/matlab/handler.py

@@ -358,7 +358,15 @@ class MatlabHandler(BaseHandler):
             raise CollectionError("Empty identifier")
 
         final_config = ChainMap(config, self.default_config)  # type: ignore[arg-type]
-        model = self.paths.resolve(identifier, config=final_config)
+        try:
+            model = self.paths.resolve(identifier, config=final_config)
+        except SyntaxError as ex:
+            msg = str(ex)
+            if ex.text:
+                msg += ':\n' + ex.text
+            raise CollectionError(msg) from ex
+        except Exception as ex:
+            raise CollectionError(str(ex)) from ex
         if model is None:
             raise CollectionError(f"Identifier '{identifier}' not found")
         return model

{mkdocstrings_matlab-0.9.1 → mkdocstrings_matlab-0.9.3}/src/mkdocstrings_handlers/matlab/treesitter.py

@@ -198,6 +198,7 @@ class FileParser(object):
         self.encoding: str = result.encoding if result else "utf-8"
         with open(filepath, "rb") as f:
             self._content: bytes = f.read()
+        self._node: Node | None = None
 
     @property
     def content(self):
@@ -226,26 +227,38 @@ class FileParser(object):
         Raises:
             ValueError: If the file could not be parsed.
         """
-        tree = PARSER.parse(self._content)
-        cursor = tree.walk()
-
-        if cursor.node is None:
-            raise ValueError(f"The file {self.filepath} could not be parsed.")
-        captures = FILE_QUERY.captures(cursor.node)
-
-        if "function" in captures:
-            model = self._parse_function(captures["function"][0], **kwargs)
-        elif "class" in captures:
-            model = self._parse_class(captures["class"][0], **kwargs)
-        else:
-            model = Script(self.filepath.stem, filepath=self.filepath, **kwargs)
+        try:
+            tree = PARSER.parse(self._content)
+            cursor = tree.walk()
+
+            if cursor.node is None:
+                raise ValueError(f"The file {self.filepath} could not be parsed.")
+            captures = FILE_QUERY.captures(cursor.node)
+            if "function" in captures:
+                model = self._parse_function(captures["function"][0], **kwargs)
+            elif "class" in captures:
+                model = self._parse_class(captures["class"][0], **kwargs)
+            else:
+                model = Script(self.filepath.stem, filepath=self.filepath, **kwargs)
 
-        if not model.docstring:
-            model.docstring = self._comment_docstring(
-                captures.get("header", None), parent=model
-            )
+            if not model.docstring:
+                model.docstring = self._comment_docstring(
+                    captures.get("header", None), parent=model
+                )
 
-        return model
+            return model
+        except Exception as ex:
+            syntax_error = SyntaxError(f"Error parsing Matlab file")
+            syntax_error.filename = str(self.filepath)
+            if self._node is not None:
+                if self._node.text is not None:
+                    indentation = ' ' * self._node.start_point.column
+                    syntax_error.text = indentation + self._node.text.decode(self.encoding)
+                syntax_error.lineno = self._node.start_point.row + 1
+                syntax_error.offset = self._node.start_point.column + 1
+                syntax_error.end_lineno = self._node.end_point.row + 1
+                syntax_error.end_offset = self._node.end_point.column + 1
+            raise syntax_error from ex
 
     def _parse_class(self, node: Node, **kwargs: Any) -> Class:
         """
@@ -262,6 +275,7 @@ class FileParser(object):
         Returns:
             Class: The parsed Class or Classfolder model.
         """
+        self._node = node
         saved_kwargs = {key: value for key, value in kwargs.items()}
         captures = CLASS_QUERY.captures(node)
 
@@ -401,6 +415,7 @@ class FileParser(object):
                              The value is `True` if no value is specified,
                              otherwise it is the parsed value which can be a boolean or a string.
         """
+        self._node = node
         captures = ATTRIBUTE_QUERY.captures(node)
 
         key = self._first_from_capture(captures, "name")
@@ -429,6 +444,7 @@ class FileParser(object):
             KeyError: If required captures are missing from the node.
 
         """
+        self._node = node
         captures: dict = FUNCTION_QUERY.matches(node)[0][1]
 
         input_names = self._decode_from_capture(captures, "input")
@@ -529,6 +545,7 @@ class FileParser(object):
         Returns:
             str: The decoded text of the node. If the node or its text is None, returns an empty string.
         """
+        self._node = node
         return (
             node.text.decode(self.encoding)
             if node is not None and node.text is not None
@@ -621,6 +638,18 @@ class FileParser(object):
             except StopIteration:
                 break
 
+            # Exclude all pragma's
+            if line in [
+                '%#codegen',
+                '%#eml',
+                '%#external',
+                '%#exclude',
+                '%#function',
+                '%#ok',
+                '%#mex',
+            ]:
+                continue
+
             if "--8<--" in line:
                 continue
 

mkdocstrings_matlab-0.9.1/renovate.json

@@ -1,6 +0,0 @@
-{
-    "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-    "extends": [
-        "config:recommended"
-    ]
-}