mkdocstrings-matlab 0.3.3__tar.gz → 0.4.0__tar.gz

mkdocstrings_matlab-0.4.0/.github/CODEOWNERS

@@ -0,0 +1 @@
+* @watermarkhu

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

@@ -0,0 +1,81 @@
+name: Docs
+
+# Controls when the workflow will run
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: >-
+          Version of the documentation to publish
+        type: string
+        required: true
+      alias:
+        description: >-
+          (Versioned) Alias to use when publishing the versioned documentation with mike
+        type: string
+        default: "latest"
+      set-default:
+        description: >-
+          Set the alias as the default version
+        type: boolean
+        default: true
+  workflow_call:
+    inputs:
+      version:
+        description: >-
+          Version of the documentation to publish
+        type: string
+        required: true
+      alias:
+        description: >-
+          (Versioned) Alias to use when publishing the versioned documentation with mike
+        type: string
+        default: "latest"
+      set-default:
+        description: >-
+          Set the alias as the default version
+        type: boolean
+        default: true
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - 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
+  
+      - name: Build documentation with mike
+        run: >
+          uv run mike deploy 
+          --branch gh-pages
+          --alias-type copy
+          --update-aliases
+          --push
+          ${{ inputs.version }} ${{ inputs.alias }}
+      
+      - name: Set default alias for mike 
+        if: ${{ fromJson(inputs.set-default) }}
+        run: >
+          uv run mike set-default
+          --branch gh-pages
+          --push
+          ${{ inputs.alias }}

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

@@ -0,0 +1,82 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+  
+  pull_request:
+    branches:
+      - main
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+
+  publish:
+    name: Publish package to PyPI
+    runs-on: ubuntu-latest
+    environment: release
+    outputs:
+      released: ${{ steps.release.outputs.released }}
+      tag: ${{ steps.release.outputs.tag }}
+    concurrency: release
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+      with:
+        fetch-depth: 0
+        ref: ${{ github.sha }}
+
+    - name: Force correct release branch on workflow sha
+      run: |
+        git checkout -B ${{ github.ref_name }} ${{ github.sha }}
+
+    - name: Python semantic release
+      id: release
+      uses: python-semantic-release/python-semantic-release@v9.8.9
+      with: 
+        build: false
+        changelog: true
+        commit: true
+        push: true
+        tag: true
+        github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
+        git_committer_name: "github-actions[bot]"
+        git_committer_email: "41898282+github-actions[bot]@users.noreply.github.com"
+
+    - name: Install the latest version of uv
+      if: steps.release.outputs.released == 'true'
+      uses: astral-sh/setup-uv@v5
+      with:
+        version: "latest"
+
+    - name: Publish package to PyPI with UV
+      if: steps.release.outputs.released == 'true'
+      run: |
+        uv sync --no-dev --group docs
+        uv build
+        uv publish
+
+    - name: Publish package distributions to GitHub Releases
+      uses: python-semantic-release/upload-to-gh-release@v9.8.9
+      if: steps.release.outputs.released == 'true'
+      with:
+        github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
+        tag: ${{ steps.release.outputs.tag }}
+
+  mkdocs:
+    name: Deploy documentation
+    needs: [publish]
+    uses: ./.github/workflows/docs.yaml
+    secrets: inherit
+    with:
+      version: ${{ needs.publish.outputs.tag }}
+      alias: latest
+      set-default: true

mkdocstrings_matlab-0.4.0/.python-version

@@ -0,0 +1 @@
+3.13

{mkdocstrings_matlab-0.3.3 → mkdocstrings_matlab-0.4.0}/.vscode/launch.json

@@ -14,13 +14,13 @@
             "jinja": true
         },
         {
-            "name": "Python Debugger: mkdocstrings test",
+            "name": "Python Debugger: mkdocstrings debug docs",
             "type": "debugpy",
             "request": "launch",
-            "program": "test/debug.py",
+            "program": "docs/debug.py",
             "console": "integratedTerminal",
             "justMyCode": false,
-            "jinja": true
+            "jinja": true,
         }
     ]
-}
+}

mkdocstrings_matlab-0.4.0/.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+    "material-icon-theme.languages.associations": {
+        "jinja-html": "html"
+    },
+    "files.associations": {
+    "*.html": "jinja-html"
+   },
+    "emmet.includeLanguages": {
+        "jinja-html": "html"
+    },
+}

mkdocstrings_matlab-0.4.0/CHANGELOG.md

@@ -0,0 +1,193 @@
+# CHANGELOG
+
+## v0.4.0 (2025-01-02)
+
+### Feature
+
+* feat: fix workflows (#6)
+
+* fix workflows
+
+* set dummy git credentials
+
+* set permission
+
+* forgotten input
+
+* fix
+
+* fix
+
+* fix
+
+* fix
+
+* fix ([`d90cf92`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d90cf925c992f83bb7102e22981968615310328e))
+
+* feat: All options working (#4)
+
+* add general docs
+
+* add back parameter_headings option
+
+* improve headings section
+
+* bump mkdocstrings-python
+
+* done with headings section
+
+* fix inherited members, member order
+
+* better docs
+
+* fix docstring parameter handling
+
+* fixes
+
+* first attempt at hiding hidden and private members
+
+* working hidden and private members
+
+* finalize hidden and private members
+
+* first attempt summaries
+
+* summaries almost working
+
+* comments
+
+* updates
+
+* merge constructor
+
+* docs
+
+* hide previews
+
+* docstrings section done
+
+* finalize signatures
+
+* update logo
+
+* first attempt at workflows
+
+* finalize workflow ([`83d1588`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/83d15882e0a00252b91d2d88a19bb2f903674ca4))
+
+### Unknown
+
+* Merge 996e4e9a920c31164f5629b46b444afcc3c626b0 into 27c4fbaf1588a7f0bbd650af31a4ef5910930b07 ([`4909e1f`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/4909e1fa7d6609d6e2eff2a449486077274290a3))
+
+* match all ([`996e4e9`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/996e4e9a920c31164f5629b46b444afcc3c626b0))
+
+* fixes ([`7d62914`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/7d62914126ab33d5fb9f80eccf1c984762c3bcf2))
+
+* fix conf ([`d327dbf`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d327dbfd160bb35da7d1a1d11eb1c4cceb462f1a))
+
+* Merge branch 'main' into release ([`4f4f744`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/4f4f7442551d03c235b05976f3643d2212b65c56))
+
+* release (#7) ([`27c4fba`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/27c4fbaf1588a7f0bbd650af31a4ef5910930b07))
+
+* fix ([`d999d25`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d999d2597b4bde4edd2f8f1770f7023ded4ac85a))
+
+* release ([`22bb966`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/22bb9665ea8e6f6fc82e664aaf0c16aa812ad37b))
+
+* release ([`f35fb1d`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/f35fb1d52ff9948bc8bd60f22bc87a01e63f2eef))
+
+* Create docs.yaml (#5) ([`e3c24ac`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/e3c24ac87548691c4778ba4ea6bf10d6d4e1ddbd))
+
+## v0.3.3 (2024-12-19)
+
+### Unknown
+
+* downgrade mkdocstrings-python ([`d520c2b`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d520c2bf1c62bf844a3b4ba68f6f3cf113975307))
+
+* bump ([`f147e0a`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/f147e0aa10d02dacadc49cad4c58406525300eef))
+
+* support Contents.m and readme.md ([`41c3abc`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/41c3abcf272561b3af9d2320658e069249069e90))
+
+* update logo ([`861f34a`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/861f34ac6ec6b40d8067e2dacd3ad292f7315030))
+
+* Use tree sitter (#3)
+
+* parse function
+
+* parse class
+
+* add matlab-path
+
+* restructure
+
+* working collector
+
+* collection almost fully
+
+* working?
+
+* working
+
+* working
+
+* working :)
+
+* Create parameter documentation from argument blocks
+
+* fully working
+
+* use query api for functions
+
+* fully working
+
+* uv fixes
+
+* orginazation
+
+* improvements
+
+* labels and symbol name fix via module
+
+* add pyright config
+
+* pyright fixes
+
+* fix method parent
+
+* add docstrings
+
+* fixes signature
+
+* checked all options
+
+* Finalize ([`6783e67`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/6783e673b4ccb0044a22c6ca462940450ff1a158))
+
+* Change tool to uv from rye ([`4e97b3f`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/4e97b3fb2dda0a64bdc9d128e9004a2cda1ee1e0))
+
+* fix size bug ([`6ec7d59`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/6ec7d59e15f8113a482b3bc7b9b4043cac092f25))
+
+* fix properties ([`9bb1ba3`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/9bb1ba34bd5536fbd06952aa2e469f31c07116b9))
+
+* small bugfixes ([`83be91e`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/83be91e2be03f5993344d213e20907fba4c95fea))
+
+* add r2024b support ([`948cd3a`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/948cd3a16b2bc930135ea4bcf2f0a76b4633b0df))
+
+* Development (#2)
+
+* fix when paths is empty
+
+* Add support for inheritance diagrams
+
+* Finalize inheritance diagram
+
+* bump version ([`3449226`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/34492263fbf00c400bf3b4f919a5c89d2fc66046))
+
+* Merge pull request #1 from watermarkhu/development
+
+Development ([`99cf8d5`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/99cf8d5c65d9d27c18750e7517cc97ffb2098476))
+
+* fix class ([`89bd1c1`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/89bd1c17a1bb0350c02a2e96b946103a73398332))
+
+* bump ([`e2ec8f3`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/e2ec8f3b09036833cc6a93e8106cb69fb1c82cd3))
+
+* Resolve paths relatively to the configuration file ([`6fdda75`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/6fdda75eeb2a78eb0cb7ea864ddea96282eb4ca4))
+
+* first commit ([`88ea479`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/88ea479b0789dc64818aaa6831e6847941f9ea1a))

{mkdocstrings_matlab-0.3.3 → mkdocstrings_matlab-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.3.3
+Version: 0.4.0
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: ISC
@@ -24,7 +24,7 @@ Requires-Python: >=3.10
 Requires-Dist: charset-normalizer>=3.3.2
 Requires-Dist: griffe>=1.5.1
 Requires-Dist: mkdocs==1.6.1
-Requires-Dist: mkdocstrings-python==1.10.9
+Requires-Dist: mkdocstrings-python==1.13.0
 Requires-Dist: mkdocstrings==0.27.0
 Requires-Dist: tree-sitter-matlab>=1.0.2
 Requires-Dist: tree-sitter>=0.23.2
@@ -37,7 +37,7 @@ Description-Content-Type: text/markdown
 
 ---
 
-<p align="center"><img src="logo.png"></p>
+<p align="center"><img src="logo.svg"></p>
 
 The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. Via the python bindings the Abstract Syntax Tree (AST) of the source code is traversed to extract useful information. The imported objected are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
 

{mkdocstrings_matlab-0.3.3 → mkdocstrings_matlab-0.4.0}/README.md

@@ -5,7 +5,7 @@
 
 ---
 
-<p align="center"><img src="logo.png"></p>
+<p align="center"><img src="logo.svg"></p>
 
 The MATLAB handler uses [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab) to collect documentation from MATLAB source code. Via the python bindings the Abstract Syntax Tree (AST) of the source code is traversed to extract useful information. The imported objected are imported as custom [Griffe](https://mkdocstrings.github.io/griffe/) objects and mocked for the [python handler](https://mkdocstrings.github.io/python/). 
 

{mkdocstrings_matlab-0.3.3/test → mkdocstrings_matlab-0.4.0/docs}/debug.py

@@ -15,17 +15,16 @@ def set_directory(path: Path):
         os.chdir(origin)
 
 
-config_path = Path(__file__).parent.resolve() / "mkdocs.yml"
+config_path = Path(__file__).parent.parent.resolve() / "mkdocs.yml"
 
 kwargs = {
     "dev_addr": None,
     "open_in_browser": False,
-    "livereload": True,
+    "livereload": False,
     "build_type": None,
     "watch_theme": True,
     "config_file": str(config_path),
     "strict": None,
-    "theme": None,
     "use_directory_urls": None,
 }
 

mkdocstrings_matlab-0.4.0/docs/logo.svg

@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
+<svg
+   role="img"
+   viewBox="0 0 24 24"
+   version="1.1"
+   id="svg6"
+   sodipodi:docname="mkdocstrings-matlab.svg"
+   inkscape:version="1.1.2 (b8e25be833, 2022-02-05)"
+   xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
+   xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
+   xmlns="http://www.w3.org/2000/svg"
+   xmlns:svg="http://www.w3.org/2000/svg"
+   xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
+   xmlns:cc="http://creativecommons.org/ns#"
+   xmlns:dc="http://purl.org/dc/elements/1.1/">
+  <defs
+     id="defs10" />
+  <sodipodi:namedview
+     id="namedview8"
+     pagecolor="#ffffff"
+     bordercolor="#666666"
+     borderopacity="1.0"
+     inkscape:pageshadow="2"
+     inkscape:pageopacity="0.0"
+     inkscape:pagecheckerboard="0"
+     showgrid="false"
+     inkscape:zoom="36.375"
+     inkscape:cx="11.986254"
+     inkscape:cy="14.185567"
+     inkscape:window-width="3760"
+     inkscape:window-height="2126"
+     inkscape:window-x="-11"
+     inkscape:window-y="-11"
+     inkscape:window-maximized="1"
+     inkscape:current-layer="svg6" />
+  <title
+     id="title2">Material for MkDocs</title>
+  <path
+     d="m 17.029,18.772 c -6.314,-9.47 0,0 -6.314,-9.47 L 18.582,4.062 24,1.354 V 16.84 l -5.417,2.709 z M 19.052,4.945 v 13.253 l 3.949,-1.975 V 2.97 Z"
+     id="path4"
+     style="display:inline;fill:#2777aa;fill-opacity:1"
+     sodipodi:nodetypes="cccccccccccc" />
+  <metadata
+     id="metadata71">
+    <rdf:RDF>
+      <cc:Work
+         rdf:about="">
+        <dc:title>Material for MkDocs</dc:title>
+      </cc:Work>
+    </rdf:RDF>
+  </metadata>
+  <path
+     d="M 17.806,19.938 12.389,22.647 0,16.451 V 4.063 L 5.417,1.354 c 12.389,18.584 0,0 12.389,18.584 z M 5.076,2.642 1.458,4.45 12.73,21.358 16.348,19.549 Z"
+     id="path148"
+     style="display:inline;fill:#ba5500;fill-opacity:1"
+     sodipodi:nodetypes="ccccccccccc" />
+</svg>

mkdocstrings_matlab-0.4.0/docs/snippets/+module/+submodule/Contents.m

@@ -0,0 +1 @@
+% This is a submodule

mkdocstrings_matlab-0.4.0/docs/snippets/+module/+submodule/subfunction.m

@@ -0,0 +1,3 @@
+function subfunction
+    % This is a subfunction.
+end

mkdocstrings_matlab-0.4.0/docs/snippets/+module/aClass.m

@@ -0,0 +1,15 @@
+classdef aClass
+    % Summary.
+    %
+    % Long description.
+    %
+    % Methods:
+    %     foo: Some method.
+
+    methods
+        function foo()
+            % Summary.
+        end
+    end
+end
+    

mkdocstrings_matlab-0.4.0/docs/snippets/+module/do_something.m

@@ -0,0 +1,3 @@
+function do_something()
+% Do something.
+end

mkdocstrings_matlab-0.4.0/docs/snippets/+module/module.md

@@ -0,0 +1,43 @@
+??? code "Source files"
+
+    === ":material-file-tree: tree"
+
+        ```tree
+        +module
+            +submodule
+                Contents.m
+                subfunction.m
+            aClass.m
+            do_something.m
+            readme.m
+        ```
+
+    === ":material-file-code: `readme.md`"
+
+        ```matlab
+        --8<-- "docs/snippets/+module/readme.md"
+        ```
+
+    === ":material-file-code: `do_something.m`"
+
+        ```matlab
+        --8<-- "docs/snippets/+module/do_something.m"
+        ```
+    
+    === ":material-file-code: `aClass.m`"
+
+        ```matlab
+        --8<-- "docs/snippets/+module/aClass.m"
+        ```
+
+    === ":material-file-code: `subfunction.m`"
+
+        ```matlab
+        --8<-- "docs/snippets/+module/+submodule/subfunction.m"
+        ```
+
+    === ":material-file-code: `Contents.m`"
+
+        ```matlab
+        --8<-- "docs/snippets/+module/+submodule/Contents.m"
+        ```

mkdocstrings_matlab-0.4.0/docs/snippets/+module/readme.md

@@ -0,0 +1,10 @@
+Docstring of module.
+
+Functions:
+    do_something: Do something.
+
+Classes:
+    aClass: Summary
+
+Namespaces:
+    submodule: This is a submodule

mkdocstrings_matlab-0.4.0/docs/snippets/+mymembers/BaseClass.m

@@ -0,0 +1,8 @@
+classdef (Abstract) BaseClass
+% Base class docstring.
+    methods
+        function obj = from_base(obj, input)
+            % Base method docstring
+        end
+    end
+end

mkdocstrings_matlab-0.4.0/docs/snippets/+mymembers/Contents.m

@@ -0,0 +1 @@
+% This is the namespace docstring.

mkdocstrings_matlab-0.4.0/docs/snippets/+mymembers/ThisClass.m

@@ -0,0 +1,38 @@
+classdef ThisClass < mymembers.BaseClass
+    % Class docstring.
+    methods
+        function obj = other_method(obj, input)
+            % Method docstring
+        end
+        function obj = method(obj, input)
+            % Method docstring
+        end
+        function delete(obj)
+            % Destructor docstring
+        end
+    end
+
+    properties
+        public_property % Public property docstring
+    end
+
+    methods (Hidden)
+        function obj = hidden_method(obj, input)
+            % Hidden method docstring
+        end
+    end
+
+    methods (Access = private)
+        function obj = private_method(obj, input)
+            % Private method docstring
+        end
+    end
+
+    properties (Hidden)
+        hidden_property % Hidden property docstring
+    end
+
+    properties (SetAccess = private)
+        private_property % Private property docstring
+    end
+end

mkdocstrings_matlab-0.4.0/docs/snippets/+mymembers/mymembers.md

@@ -0,0 +1,35 @@
+??? code "Source files"
+
+    === ":material-file-tree: tree"
+
+        ```tree
+        +mymembers
+            Contents.m
+            BaseClass.m
+            ThisClass.m
+            this_function.m
+        ```
+
+    === ":material-file-code: `Contents.m`"
+
+        ```matlab
+        --8<-- "docs/snippets/+mymembers/Contents.m"
+        ```
+    
+    === ":material-file-code: `ThisClass.m`"
+
+        ```matlab
+        --8<-- "docs/snippets/+mymembers/ThisClass.m"
+        ```
+
+    === ":material-file-code: `BaseClass.m`"
+
+        ```matlab
+        --8<-- "docs/snippets/+mymembers/BaseClass.m"
+        ```
+
+    === ":material-file-code: `this_function.m`"
+
+        ```matlab
+        --8<-- "docs/snippets/+mymembers/this_function.m"
+        ```

mkdocstrings_matlab-0.4.0/docs/snippets/+mymembers/this_function.m

@@ -0,0 +1,3 @@
+function this_function()
+    % Function docstring
+end