mkdocstrings-matlab 2.0.4__tar.gz → 2.1.1__tar.gz

{mkdocstrings_matlab-2.0.4 → mkdocstrings_matlab-2.1.1}/.github/renovate.json5

@@ -51,7 +51,6 @@
         "pytest-cov",
         "beautifulsoup4",
         "inline-snapshot",
-        "python-semantic-release",
       ],
       semanticCommitType: "build",
       semanticCommitScope: "deps",
@@ -67,11 +66,6 @@
         "pygments",
         "mkdocs-material",
         "mkdocstrings-python",
-        "markdown-exec",
-        "mkdocs-callouts",
-        "mkdocs-git-revision-date-localized-plugin",
-        "mkdocs-minify-plugin",
-        "mike",
       ],
       semanticCommitType: "docs",
       semanticCommitScope: "deps",

mkdocstrings_matlab-2.1.1/.github/workflows/docs.yaml

@@ -0,0 +1,64 @@
+name: Docs
+
+# Controls when the workflow will run
+on:
+  workflow_call:
+    inputs:
+      ref:
+        description: >-
+          The ref to checkout and use to create docs
+        type: string
+        default: ""
+      push:
+        description: >-
+          Push the documentation to the remote branch
+        type: boolean
+        default: true
+      type:
+        description: >-
+          MkDocs or zensical
+        type: string
+        default: zensical
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/configure-pages@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@v10.0.1
+        with:
+          version: "latest"
+
+      - name: Sync dependencies
+        if: inputs.type == 'zensical'
+        run: |
+          uv sync --no-dev --group docs
+          uv run zensical build --clean
+
+      - name: Build documentation
+        if: inputs.type == 'mkdocs'
+        run: |
+          uv sync --no-dev --group mkdocs
+          uv run mkdocs build --clean
+
+      - uses: actions/upload-pages-artifact@v5
+        if: ${{ inputs.push }}
+        with:
+          path: site
+
+      - uses: actions/deploy-pages@v5
+        if: ${{ inputs.push }}
+        id: deployment

mkdocstrings_matlab-2.1.1/.github/workflows/qualify.yaml

@@ -0,0 +1,196 @@
+name: Qualify
+
+on:
+  merge_group:
+  push:
+    branches: [main]
+  pull_request:
+    types:
+      - opened
+      - closed
+      - reopened
+      - synchronize
+      - labeled
+      - unlabeled
+      - edited
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.ref_name }}
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    name: Test deploy documentation
+    uses: ./.github/workflows/docs.yaml
+    strategy:
+      matrix:
+        type: [mkdocs, zensical]
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    secrets: inherit
+    with:
+      push: false
+      type: ${{ matrix.type }}
+
+  setup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    outputs:
+      python-versions: ${{ steps.get-versions.outputs.python-versions }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Get Python versions from pyproject.toml
+        id: get-versions
+        run: |
+          # Extract Python versions from classifiers
+          versions=$(grep -E "Programming Language :: Python :: 3\.[0-9]+" pyproject.toml | \
+                    sed -E 's/.*Python :: (3\.[0-9]+).*/\1/' | \
+                    sort -V | \
+                    jq -R -s -c 'split("\n")[:-1]')
+          echo "python-versions=$versions" >> $GITHUB_OUTPUT
+          echo "Found Python versions: $versions"
+
+  test:
+    name: Run checks and tests
+    needs: setup
+    permissions:
+      contents: read
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ${{ fromJson(needs.setup.outputs.python-versions) }}
+        resolution: [highest, lowest]
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v7
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v10.0.1
+        with:
+          version: "latest"
+
+      - name: Cache uv
+        id: cache-uv
+        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') }}
+
+      - name: Install dependencies
+        env:
+          PYTHON_VERSION: ${{ matrix.python-version }}
+          UV_RESOLUTION: ${{ matrix.resolution }}
+        run: |
+          uv sync --dev --python ${PYTHON_VERSION} --resolution ${UV_RESOLUTION}
+
+      - name: Run ruff linting
+        run: |
+          echo "## 🔍 Ruff Linting Results" >> $GITHUB_STEP_SUMMARY
+          if uv run ruff check --output-format=github .; then
+            echo "✅ No linting errors found" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Linting errors found" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+      - name: Run ruff formatting check
+        run: |
+          echo "## 🎨 Code Formatting Check" >> $GITHUB_STEP_SUMMARY
+          if uv run ruff format --check .; then
+            echo "✅ Code formatting is correct" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Code formatting issues found" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+      - name: Run Ty type checking
+        run: |
+          echo "## 🔧 Ty Type Checking Results" >> $GITHUB_STEP_SUMMARY
+          if uv run ty check; then
+            echo "✅ No type errors found" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Type errors found" >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+      - name: Run tests
+        run: |
+          if uv run pytest -v --tb=short --color=yes \
+            --cov mkdocstrings_handlers.matlab --cov-branch --cov-report=xml \
+            --junit-xml=pytest.xml; then
+            echo '# ✅ Tests passed' >> $GITHUB_STEP_SUMMARY
+          else
+            echo '# ❌ Tests failed' >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi
+
+      - name: Generate test coverage report
+        if: (!cancelled())
+        run: |
+          echo '### Test Coverage Summary' >> $GITHUB_STEP_SUMMARY
+          uv run coverage report --show-missing --format=markdown >> $GITHUB_STEP_SUMMARY
+
+      - name: Upload Test Results
+        if: (!cancelled())
+        uses: actions/upload-artifact@v7
+        with:
+          name: python${{ matrix.python-version }}-${{ matrix.resolution }}
+          path: "*.xml"
+
+  summary:
+    runs-on: ubuntu-latest
+    needs: [setup, test]
+    if: (!cancelled())
+    permissions:
+      contents: read
+      checks: write
+      id-token: write
+      pull-requests: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v7
+        with:
+          fetch-depth: 2
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v8
+        with:
+          path: results
+
+      - name: Publish Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        with:
+          files: "results/**/pytest.xml"
+
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v7
+        with:
+          use_oidc: true
+          directory: results
+
+      - name: Upload test results to Codecov
+        uses: codecov/test-results-action@v1
+        with:
+          use_oidc: true
+          directory: results
+
+      - name: Check all jobs
+        run: |
+          if [[ "${{ needs.test.result }}" == "success" ]]; then
+            echo "✅ All Python versions passed CI checks"
+            echo "## 🎉 CI Summary" >> $GITHUB_STEP_SUMMARY
+            echo "All tests passed across Python versions: ${{ needs.setup.outputs.python-versions }}" >> $GITHUB_STEP_SUMMARY
+          else
+            echo "❌ Some Python versions failed CI checks"
+            echo "## ❌ CI Summary" >> $GITHUB_STEP_SUMMARY
+            echo "Some tests failed. Check individual job results for details." >> $GITHUB_STEP_SUMMARY
+            exit 1
+          fi

mkdocstrings_matlab-2.1.1/.github/workflows/release.yaml

@@ -0,0 +1,117 @@
+name: Release
+
+on:
+  pull_request:
+    types:
+      - closed
+      - opened
+      - reopened
+      - synchronize
+    branches: [main]
+
+jobs:
+  release:
+    name: Semantic version release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write # Required for adding the labels to the PR
+      issues: write # Required for adding labels to the repository
+    outputs:
+      release: ${{ steps.get-version.outputs.release }}
+      tag: ${{ steps.get-version.outputs.tag }}
+      version: ${{ steps.get-version.outputs.version }}
+    steps:
+      - name: Get semantic version
+        uses: RonaldPhilipsen/semVersie@v2.3.4
+        id: get-version
+        with:
+          add-pr-label: true
+          label-prefix: false
+
+  deploy:
+    name: Deploy package distributions
+    needs: release
+    if: needs.release.outputs.release == 'true' && github.event.pull_request.merged
+    runs-on: ubuntu-latest
+    environment: release
+    defaults:
+      run:
+        shell: bash
+    permissions:
+      contents: write
+      id-token: write
+    steps:
+      - uses: actions/create-github-app-token@v3
+        id: app-token
+        with:
+          app-id: ${{ vars.APP_ID }}
+          private-key: ${{ secrets.APP_PRIVATE_KEY }}
+
+      - name: Install the latest version of uv
+        uses: astral-sh/setup-uv@v10.0.1
+        with:
+          version: "latest"
+
+      - name: Checkout repository
+        uses: actions/checkout@v7
+        with:
+          token: ${{ steps.app-token.outputs.token }}
+
+      - name: Set credentials for git
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
+          APP_SLUG: ${{ steps.app-token.outputs.app-slug }}
+        run: |
+          USER_ID=$(gh api "/users/${APP_SLUG}[bot]" --jq .id)
+          git config --global user.name "${APP_SLUG}[bot]"
+          git config --global user.email "${USER_ID}+${APP_SLUG}[bot]@users.noreply.github.com"
+
+      - name: Update version in pyproject.toml
+        env:
+          VERSION: ${{ needs.release.outputs.version }}
+        run: |
+          sed -i "s/version = \"0.0.0\"/version = \"${VERSION}\"/" pyproject.toml
+          git add pyproject.toml
+
+      - name: Build package distributions
+        run: |
+          uv sync --no-dev
+          uv build
+
+      - name: Create commit and tag
+        env:
+          VERSION: ${{ needs.release.outputs.version }}
+          TAG: ${{ needs.release.outputs.tag }}
+        run: |
+          git commit -m "chore: bump version to ${VERSION}"
+          git tag -a ${TAG} -m "Release ${VERSION}"
+          git push -f origin ${TAG}
+
+      - name: Publish package distributions
+        run: |
+          uv publish
+
+      - name: Create release
+        env:
+          GH_TOKEN: ${{ steps.app-token.outputs.token }}
+          TAG: ${{ needs.release.outputs.tag }}
+        run: >
+          gh release create "${TAG}"
+          dist/*.whl
+          dist/*.tar.gz
+          --generate-notes
+          --verify-tag
+
+  document:
+    name: Deploy documentation
+    needs: [release]
+    if: github.event.pull_request.merged
+    uses: ./.github/workflows/docs.yaml
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    secrets: inherit
+    with:
+      push: true

{mkdocstrings_matlab-2.0.4 → mkdocstrings_matlab-2.1.1}/.pre-commit-config.yaml

@@ -7,7 +7,7 @@ repos:
       - id: check-merge-conflict
 
   - repo: https://github.com/abravalheri/validate-pyproject
-    rev: v0.25
+    rev: 0.26
     hooks:
       - id: validate-pyproject
 

{mkdocstrings_matlab-2.0.4 → mkdocstrings_matlab-2.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: mkdocstrings-matlab
-Version: 2.0.4
+Version: 2.1.1
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -21,11 +21,11 @@ Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: <3.15,>=3.10
-Requires-Dist: charset-normalizer~=3.4
-Requires-Dist: griffe~=2.0.0
-Requires-Dist: maxx~=0.7.0
-Requires-Dist: mkdocs-autorefs~=1.4
-Requires-Dist: mkdocstrings~=1.0
+Requires-Dist: charset-normalizer<4,>=3.4
+Requires-Dist: griffe<3,>=2.0.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'
 Description-Content-Type: text/markdown
 
@@ -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.0.4 → mkdocstrings_matlab-2.1.1}/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.0.4 → mkdocstrings_matlab-2.1.1}/docs/src/snippets/+mynamespace/mynamespace.md

@@ -8,6 +8,7 @@
             classA.m
             classB.m
             typed_function.m
+            typed_class_property.m
             myscript.m
         ```
 
@@ -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.1/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