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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (77) hide show
  1. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/.github/workflows/docs.yaml +8 -20
  2. mkdocstrings_matlab-0.4.2/.github/workflows/qualify.yaml +88 -0
  3. mkdocstrings_matlab-0.4.2/.github/workflows/release.yaml +98 -0
  4. mkdocstrings_matlab-0.4.2/CHANGELOG.md +99 -0
  5. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/LICENSE +1 -1
  6. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/PKG-INFO +6 -7
  7. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/README.md +5 -4
  8. mkdocstrings_matlab-0.4.2/docs/changelog.md +1 -0
  9. mkdocstrings_matlab-0.4.2/docs/credits.md +7 -0
  10. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/stylesheets/extra.css +1 -0
  11. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/mkdocs.yml +3 -3
  12. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/pyproject.toml +1 -4
  13. mkdocstrings_matlab-0.4.2/renovate.json +6 -0
  14. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/handler.py +1 -1
  15. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/uv.lock +4 -8
  16. mkdocstrings_matlab-0.4.0/.github/workflows/release.yaml +0 -82
  17. mkdocstrings_matlab-0.4.0/CHANGELOG.md +0 -193
  18. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/.github/CODEOWNERS +0 -0
  19. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/.gitignore +0 -0
  20. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/.python-version +0 -0
  21. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/.vscode/launch.json +0 -0
  22. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/.vscode/settings.json +0 -0
  23. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/debug.py +0 -0
  24. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/index.md +0 -0
  25. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/license.md +0 -0
  26. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/logo.png +0 -0
  27. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/logo.svg +0 -0
  28. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/+submodule/Contents.m +0 -0
  29. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/+submodule/subfunction.m +0 -0
  30. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/aClass.m +0 -0
  31. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/do_something.m +0 -0
  32. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/module.md +0 -0
  33. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/readme.md +0 -0
  34. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/BaseClass.m +0 -0
  35. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/Contents.m +0 -0
  36. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/ThisClass.m +0 -0
  37. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/mymembers.md +0 -0
  38. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/this_function.m +0 -0
  39. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/classA.m +0 -0
  40. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/classB.m +0 -0
  41. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/mynamespace.md +0 -0
  42. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/readme.md +0 -0
  43. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/typed_function.m +0 -0
  44. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+undocumented/ClassWithoutDocstring.m +0 -0
  45. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+undocumented/function_with_docstring.m +0 -0
  46. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+undocumented/function_without_docstring.m +0 -0
  47. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/+undocumented/undocumented.md +0 -0
  48. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/Class.m +0 -0
  49. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/OtherClass.m +0 -0
  50. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/Thing.m +0 -0
  51. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/do_output.m +0 -0
  52. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/do_something.m +0 -0
  53. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/do_varargin.m +0 -0
  54. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/myClass.m +0 -0
  55. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/myParent.m +0 -0
  56. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/myfunction.m +0 -0
  57. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/snippets/print_hello.m +0 -0
  58. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/docstrings.md +0 -0
  59. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/general.md +0 -0
  60. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/headings.md +0 -0
  61. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/members.md +0 -0
  62. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/signatures.md +0 -0
  63. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/docstrings/google.md +0 -0
  64. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/docstrings/numpy.md +0 -0
  65. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/docstrings/sphinx.md +0 -0
  66. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/docs/usage/index.md +0 -0
  67. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/logo.svg +0 -0
  68. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/requirements.lock +0 -0
  69. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocs_material_matlab/__init__.py +0 -0
  70. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocs_material_matlab/css/style.css +0 -0
  71. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocs_material_matlab/mkdocs_material_matlab.py +0 -0
  72. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/__init__.py +0 -0
  73. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/collect.py +0 -0
  74. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/enums.py +0 -0
  75. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/models.py +0 -0
  76. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/py.typed +0 -0
  77. {mkdocstrings_matlab-0.4.0 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/treesitter.py +0 -0
@@ -2,7 +2,7 @@ name: Docs
2
2
 
3
3
  # Controls when the workflow will run
4
4
  on:
5
- workflow_dispatch:
5
+ workflow_call:
6
6
  inputs:
7
7
  version:
8
8
  description: >-
@@ -19,21 +19,9 @@ on:
19
19
  Set the alias as the default version
20
20
  type: boolean
21
21
  default: true
22
- workflow_call:
23
- inputs:
24
- version:
25
- description: >-
26
- Version of the documentation to publish
27
- type: string
28
- required: true
29
- alias:
22
+ push:
30
23
  description: >-
31
- (Versioned) Alias to use when publishing the versioned documentation with mike
32
- type: string
33
- default: "latest"
34
- set-default:
35
- description: >-
36
- Set the alias as the default version
24
+ Push the documentation to the remote branch
37
25
  type: boolean
38
26
  default: true
39
27
 
@@ -64,18 +52,18 @@ jobs:
64
52
  git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
65
53
 
66
54
  - name: Build documentation with mike
55
+ env:
56
+ PUSH_DEPLOY: ${{ fromJson(inputs.push) && '--push' || '' }}
67
57
  run: >
68
- uv run mike deploy
58
+ uv run mike deploy ${PUSH_DEPLOY}
69
59
  --branch gh-pages
70
- --alias-type copy
71
- --update-aliases
72
- --push
60
+ --alias-type symlink
73
61
  ${{ inputs.version }} ${{ inputs.alias }}
74
62
 
75
63
  - name: Set default alias for mike
76
64
  if: ${{ fromJson(inputs.set-default) }}
77
65
  run: >
78
66
  uv run mike set-default
79
- --branch gh-pages
67
+ --branch gh-pages
80
68
  --push
81
69
  ${{ inputs.alias }}
@@ -0,0 +1,88 @@
1
+ name: Qualify
2
+
3
+ on:
4
+ merge_group:
5
+ pull_request:
6
+ types:
7
+ - opened
8
+ - closed
9
+ - reopened
10
+ - synchronize
11
+ - labeled
12
+ - unlabeled
13
+ branches:
14
+ - main
15
+
16
+ permissions:
17
+ contents: write
18
+ pull-requests: write
19
+
20
+ jobs:
21
+ docs:
22
+ if: github.event.pull_request.draft == false
23
+ name: Test deploy documentation
24
+ uses: ./.github/workflows/docs.yaml
25
+ secrets: inherit
26
+ with:
27
+ version: __test__
28
+ alias: ""
29
+ set-default: false
30
+ push: false
31
+
32
+ check-semantic-version:
33
+ name: Check semantic version
34
+ runs-on: ubuntu-latest
35
+ steps:
36
+
37
+ - name: Checkout repository
38
+ uses: actions/checkout@v4
39
+ with:
40
+ fetch-depth: 0
41
+ ref: ${{ github.sha }}
42
+
43
+ - name: Force correct release branch on workflow sha
44
+ run: |
45
+ git checkout -B ${{ github.ref_name }} ${{ github.sha }}
46
+
47
+ - name: Install the latest version of uv
48
+ uses: astral-sh/setup-uv@v5
49
+ with:
50
+ version: "latest"
51
+
52
+ - name: Check next semantic version
53
+ run: |
54
+ uv sync --dev
55
+ OUTPUT=$(uv run semantic-release --noop version --print)
56
+ echo "$OUTPUT"
57
+ if [ -z "$OUTPUT" ]; then
58
+ echo "comment=No release will be made." >> $GITHUB_ENV
59
+ else
60
+ echo "comment=The next release will be v$OUTPUT" >> $GITHUB_ENV
61
+ fi
62
+
63
+ - name: Find Comment
64
+ id: fc
65
+ uses: peter-evans/find-comment@v3
66
+ with:
67
+ issue-number: ${{ github.event.pull_request.number }}
68
+ comment-author: 'github-actions[bot]'
69
+ body-includes: This comment was written by a bot!
70
+
71
+ - name: Create comment
72
+ if: steps.fc.outputs.comment-id == ''
73
+ uses: peter-evans/create-or-update-comment@v4
74
+ with:
75
+ issue-number: ${{ github.event.pull_request.number }}
76
+ body: |
77
+ ${{ env.comment }}
78
+ <!-- This comment was written by a bot! -->
79
+
80
+ - name: Update comment
81
+ if: steps.fc.outputs.comment-id != ''
82
+ uses: peter-evans/create-or-update-comment@v4
83
+ with:
84
+ comment-id: ${{ steps.fc.outputs.comment-id }}
85
+ edit-mode: replace
86
+ body: |
87
+ ${{ env.comment }}
88
+ <!-- This comment was written by a bot! -->
@@ -0,0 +1,98 @@
1
+ name: Release
2
+
3
+ on:
4
+ pull_request:
5
+ types: [closed]
6
+ branches: [main]
7
+
8
+ permissions:
9
+ contents: write
10
+ id-token: write
11
+
12
+ jobs:
13
+ publish:
14
+ if: github.event.pull_request.merged == true
15
+ name: Semantic version release
16
+ runs-on: ubuntu-latest
17
+ environment: release
18
+ outputs:
19
+ released: ${{ steps.semantic-release.outputs.released }}
20
+ tag: ${{ steps.semantic-release.outputs.tag }}
21
+ concurrency: release
22
+ permissions:
23
+ id-token: write
24
+ contents: write
25
+
26
+ steps:
27
+
28
+ - uses: actions/create-github-app-token@v1
29
+ id: app-token
30
+ with:
31
+ app-id: ${{ vars.APP_ID }}
32
+ private-key: ${{ secrets.APP_PRIVATE_KEY }}
33
+
34
+ - name: Get GitHub App User ID
35
+ id: get-user-id
36
+ env:
37
+ GH_TOKEN: ${{ steps.app-token.outputs.token }}
38
+ run: echo "user-id=$(gh api "/users/${{ steps.app-token.outputs.app-slug }}[bot]" --jq .id)" >> "$GITHUB_OUTPUT"
39
+
40
+ - run: |
41
+ git config --global user.name '${{ steps.app-token.outputs.app-slug }}[bot]'
42
+ git config --global user.email '${{ steps.get-user-id.outputs.user-id }}+${{ steps.app-token.outputs.app-slug }}[bot]@users.noreply.github.com'
43
+
44
+ - name: Checkout repository
45
+ uses: actions/checkout@v4
46
+ with:
47
+ fetch-depth: 0
48
+ ref: ${{ github.sha }}
49
+ token: ${{ steps.app-token.outputs.token }}
50
+ persist-credentials: true
51
+
52
+ - name: Force correct release branch on workflow sha
53
+ run: |
54
+ git checkout -B ${{ github.ref_name }} ${{ github.sha }}
55
+
56
+ - name: Update version and changelogs
57
+ id: semantic-release
58
+ uses: python-semantic-release/python-semantic-release@v9.15.2
59
+ with:
60
+ build: false
61
+ changelog: true
62
+ commit: true
63
+ push: true
64
+ tag: true
65
+ vcs_release: true
66
+ github_token: ${{ steps.app-token.outputs.token }}
67
+
68
+ - name: Install the latest version of uv
69
+ if: steps.semantic-release.outputs.released == 'true'
70
+ uses: astral-sh/setup-uv@v5
71
+ with:
72
+ version: "latest"
73
+
74
+ - name: Build and publish package distributions
75
+ if: steps.semantic-release.outputs.released == 'true'
76
+ run: |
77
+ uv sync --no-dev
78
+ uv build
79
+ uv publish
80
+
81
+ - name: Publish package distributions to GitHub Releases
82
+ if: steps.semantic-release.outputs.released == 'true'
83
+ id: publish-dist
84
+ uses: python-semantic-release/publish-action@v9.15.2
85
+ with:
86
+ github-token: ${{ steps.app-token.outputs.token }}
87
+ tag: ${{ steps.semantic-release.outputs.tag }}
88
+
89
+ mkdocs:
90
+ name: Deploy documentation
91
+ needs: [publish]
92
+ uses: ./.github/workflows/docs.yaml
93
+ secrets: inherit
94
+ with:
95
+ version: ${{ needs.publish.outputs.tag }}
96
+ alias: latest
97
+ set-default: true
98
+ push: true
@@ -0,0 +1,99 @@
1
+ # CHANGELOG
2
+
3
+
4
+ ## v0.4.2 (2025-01-03)
5
+
6
+ ### Bug Fixes
7
+
8
+ - Automatic releases ([#29](https://github.com/watermarkhu/mkdocstrings-matlab/pull/29),
9
+ [`3d688d5`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/3d688d5ab145c6ec761f1c4830c1949974e2c20f))
10
+
11
+ - Automatic releases ([#30](https://github.com/watermarkhu/mkdocstrings-matlab/pull/30),
12
+ [`07819c2`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/07819c235551d1582a000fe9c6734f66cc131a84))
13
+
14
+ - Release artifact and documentation:
15
+ ([#27](https://github.com/watermarkhu/mkdocstrings-matlab/pull/27),
16
+ [`a0bc3ff`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/a0bc3ffb81df1af2e70e99d4d3fa62e86f9e7be8))
17
+
18
+
19
+ ## v0.4.1 (2025-01-03)
20
+
21
+ ### Bug Fixes
22
+
23
+ - Default value of parameter_headings
24
+ ([#11](https://github.com/watermarkhu/mkdocstrings-matlab/pull/11),
25
+ [`651e25d`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/651e25db05fad867d51f360ab4b1c49ececce814))
26
+
27
+ * fix default value of `parameter_headings` * add qualify workflow * documentation upgrades
28
+
29
+
30
+ ## v0.4.0 (2025-01-02)
31
+
32
+ ### Features
33
+
34
+ - All options working ([#4](https://github.com/watermarkhu/mkdocstrings-matlab/pull/4),
35
+ [`83d1588`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/83d15882e0a00252b91d2d88a19bb2f903674ca4))
36
+
37
+ * add general docs
38
+
39
+ * add back parameter_headings option
40
+
41
+ * improve headings section
42
+
43
+ * bump mkdocstrings-python
44
+
45
+ * done with headings section
46
+
47
+ * fix inherited members, member order
48
+
49
+ * better docs
50
+
51
+ * fix docstring parameter handling
52
+
53
+ * fixes
54
+
55
+ * first attempt at hiding hidden and private members
56
+
57
+ * working hidden and private members
58
+
59
+ * finalize hidden and private members
60
+
61
+ * first attempt summaries
62
+
63
+ * summaries almost working
64
+
65
+ * comments
66
+
67
+ * updates
68
+
69
+ * merge constructor
70
+
71
+ * docs
72
+
73
+ * hide previews
74
+
75
+ * docstrings section done
76
+
77
+ * finalize signatures
78
+
79
+ * update logo
80
+
81
+ * first attempt at workflows
82
+
83
+ * finalize workflow
84
+
85
+ - Fix workflows ([#6](https://github.com/watermarkhu/mkdocstrings-matlab/pull/6),
86
+ [`d90cf92`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d90cf925c992f83bb7102e22981968615310328e))
87
+
88
+ * fix workflows
89
+
90
+ * set dummy git credentials
91
+
92
+ * set permission
93
+
94
+ * forgotten input
95
+
96
+ * fix
97
+
98
+
99
+ ## v0.3.3 (2024-12-19)
@@ -1,6 +1,6 @@
1
1
  MIT License
2
2
 
3
- Copyright (c) 2024 Mark Shui Hu
3
+ Copyright (c) 2025 Mark Shui Hu
4
4
 
5
5
  Permission to use, copy, modify, and/or distribute this software for any
6
6
  purpose with or without fee is hereby granted, provided that the above
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-matlab
3
- Version: 0.4.0
3
+ Version: 0.4.2
4
4
  Summary: A MATLAB handler for mkdocstrings
5
5
  Author-email: Mark Hu <watermarkhu@gmail.com>
6
6
  License: ISC
@@ -22,8 +22,6 @@ Classifier: Topic :: Utilities
22
22
  Classifier: Typing :: Typed
23
23
  Requires-Python: >=3.10
24
24
  Requires-Dist: charset-normalizer>=3.3.2
25
- Requires-Dist: griffe>=1.5.1
26
- Requires-Dist: mkdocs==1.6.1
27
25
  Requires-Dist: mkdocstrings-python==1.13.0
28
26
  Requires-Dist: mkdocstrings==0.27.0
29
27
  Requires-Dist: tree-sitter-matlab>=1.0.2
@@ -34,10 +32,11 @@ Description-Content-Type: text/markdown
34
32
 
35
33
  <p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
36
34
 
35
+ [![qualify](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml/badge.svg)](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml)
36
+ [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-matlab)
37
+ [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
37
38
 
38
- ---
39
-
40
- <p align="center"><img src="logo.svg"></p>
39
+ <p align="center"><img width=300px src="logo.svg"></p>
41
40
 
42
41
  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/).
43
42
 
@@ -50,7 +49,7 @@ You can install this handler by specifying it as a dependency:
50
49
  # adapt to your dependencies manager
51
50
  [project]
52
51
  dependencies = [
53
- "mkdocstrings-matlab>=0.3",
52
+ "mkdocstrings-matlab>=0.X.Y",
54
53
  ]
55
54
  ```
56
55
 
@@ -2,10 +2,11 @@
2
2
 
3
3
  <p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
4
4
 
5
+ [![qualify](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml/badge.svg)](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml)
6
+ [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-matlab)
7
+ [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
5
8
 
6
- ---
7
-
8
- <p align="center"><img src="logo.svg"></p>
9
+ <p align="center"><img width=300px src="logo.svg"></p>
9
10
 
10
11
  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/).
11
12
 
@@ -18,7 +19,7 @@ You can install this handler by specifying it as a dependency:
18
19
  # adapt to your dependencies manager
19
20
  [project]
20
21
  dependencies = [
21
- "mkdocstrings-matlab>=0.3",
22
+ "mkdocstrings-matlab>=0.X.Y",
22
23
  ]
23
24
  ```
24
25
 
@@ -0,0 +1 @@
1
+ --8<-- "CHANGELOG.md"
@@ -0,0 +1,7 @@
1
+ # Credits
2
+
3
+ This project owes its existence to the incredible [`mkdocstrings`](https://mkdocstrings.github.io/), its primary extension [`mkdocstrings-python`](https://mkdocstrings.github.io/python/), and [`griffe`](https://github.com/mkdocstrings/griffe). These tools handle the templating of parsed content into HTML elements using Jinja templates, allowing much of the code and documentation to be reused and adapted for *mkdocstrings-matlab*. Special thanks to [@paramoy](https://fosstodon.org/@pawamoy) for his efforts.
4
+
5
+ Moreover, `mkdocstrings` itself extends [`mkdocs`](https://www.mkdocs.org/) and [`mkdocs-material`](https://squidfunk.github.io/mkdocs-material/), which form the foundation of the entire mkdoc* suite of documentation tools.
6
+
7
+ Finally, the parsing of MATLAB docstrings is powered by [Tree-sitter](https://tree-sitter.github.io/tree-sitter/) and its [MATLAB parser](https://github.com/acristoffers/tree-sitter-matlab). These libraries enable the parsing of MATLAB source code with exceptional speed and accuracy.
@@ -1,5 +1,6 @@
1
1
  [data-md-color-scheme="matlab"] {
2
2
  --md-primary-fg-color: #22619f;
3
+ --md-primary-fg-color--dark: #002f5b;
3
4
  }
4
5
 
5
6
  /* Custom admonition: preview */
@@ -16,8 +16,8 @@ validation:
16
16
  nav:
17
17
  - Home:
18
18
  - Overview: index.md
19
- # - Changelog: changelog.md
20
- # - Credits: credits.md
19
+ - Changelog: changelog.md
20
+ - Credits: credits.md
21
21
  - License: license.md
22
22
  - Usage:
23
23
  - usage/index.md
@@ -43,7 +43,7 @@ nav:
43
43
  # - Getting started:
44
44
  # - Installation: insiders/installation.md
45
45
  # - Changelog: insiders/changelog.md
46
- # - mkdocstrings: https://mkdocstrings.github.io/
46
+ - mkdocstrings: https://mkdocstrings.github.io/
47
47
 
48
48
  theme:
49
49
  name: material
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mkdocstrings-matlab"
3
- version = "0.4.0"
3
+ version = "0.4.2"
4
4
  description = "A MATLAB handler for mkdocstrings"
5
5
  authors = [
6
6
  { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -9,11 +9,9 @@ license = { text = "ISC" }
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
11
11
  dependencies = [
12
- "mkdocs==1.6.1",
13
12
  "mkdocstrings==0.27.0",
14
13
  "mkdocstrings-python==1.13.0", # Later versions will currently break
15
14
  "charset-normalizer>=3.3.2",
16
- "griffe>=1.5.1",
17
15
  "tree-sitter>=0.23.2",
18
16
  "tree-sitter-matlab>=1.0.2",
19
17
  ]
@@ -35,7 +33,6 @@ classifiers = [
35
33
  "Typing :: Typed",
36
34
  ]
37
35
 
38
-
39
36
  [build-system]
40
37
  requires = ["hatchling"]
41
38
  build-backend = "hatchling.build"
@@ -0,0 +1,6 @@
1
+ {
2
+ "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3
+ "extends": [
4
+ "config:recommended"
5
+ ]
6
+ }
@@ -34,7 +34,7 @@ class MatlabHandler(BaseHandler):
34
34
  "show_source": True,
35
35
  # Heading options
36
36
  "heading_level": 2,
37
- "parameter_headings": True,
37
+ "parameter_headings": False,
38
38
  "show_root_heading": False,
39
39
  "show_root_toc_entry": True,
40
40
  "show_root_full_path": True,
@@ -528,11 +528,11 @@ wheels = [
528
528
 
529
529
  [[package]]
530
530
  name = "importlib-resources"
531
- version = "6.4.5"
531
+ version = "6.5.0"
532
532
  source = { registry = "https://pypi.org/simple" }
533
- sdist = { url = "https://files.pythonhosted.org/packages/98/be/f3e8c6081b684f176b761e6a2fef02a0be939740ed6f54109a2951d806f3/importlib_resources-6.4.5.tar.gz", hash = "sha256:980862a1d16c9e147a59603677fa2aa5fd82b87f223b6cb870695bcfce830065", size = 43372 }
533
+ sdist = { url = "https://files.pythonhosted.org/packages/90/17/f0adf2fda7f289c2a6c0e7d66ab01a47de8f85f91b8c13b533ce74fe7fbc/importlib_resources-6.5.0.tar.gz", hash = "sha256:c5401947cdd2e60d426dc786e417cbbf20d0d9ab07d993b4c3cf714e271aed8b", size = 43525 }
534
534
  wheels = [
535
- { url = "https://files.pythonhosted.org/packages/e1/6a/4604f9ae2fa62ef47b9de2fa5ad599589d28c9fd1d335f32759813dfa91e/importlib_resources-6.4.5-py3-none-any.whl", hash = "sha256:ac29d5f956f01d5e4bb63102a5a19957f1b9175e45649977264a1416783bb717", size = 36115 },
535
+ { url = "https://files.pythonhosted.org/packages/13/0d/08d523ab5b9a0d6cd5d157019d8cca7c6ea40444f08be461cb959561cef6/importlib_resources-6.5.0-py3-none-any.whl", hash = "sha256:47cf6506b7900dcbde3ef334e41bf759a034e110269aa9793f0e624ddb2bf090", size = 35985 },
536
536
  ]
537
537
 
538
538
  [[package]]
@@ -979,12 +979,10 @@ wheels = [
979
979
 
980
980
  [[package]]
981
981
  name = "mkdocstrings-matlab"
982
- version = "0.4.0"
982
+ version = "0.4.2"
983
983
  source = { editable = "." }
984
984
  dependencies = [
985
985
  { name = "charset-normalizer" },
986
- { name = "griffe" },
987
- { name = "mkdocs" },
988
986
  { name = "mkdocstrings" },
989
987
  { name = "mkdocstrings-python" },
990
988
  { name = "tree-sitter" },
@@ -1011,8 +1009,6 @@ docs = [
1011
1009
  [package.metadata]
1012
1010
  requires-dist = [
1013
1011
  { name = "charset-normalizer", specifier = ">=3.3.2" },
1014
- { name = "griffe", specifier = ">=1.5.1" },
1015
- { name = "mkdocs", specifier = "==1.6.1" },
1016
1012
  { name = "mkdocstrings", specifier = "==0.27.0" },
1017
1013
  { name = "mkdocstrings-python", specifier = "==1.13.0" },
1018
1014
  { name = "tree-sitter", specifier = ">=0.23.2" },
@@ -1,82 +0,0 @@
1
- name: Release
2
-
3
- on:
4
- push:
5
- branches:
6
- - main
7
-
8
- pull_request:
9
- branches:
10
- - main
11
-
12
- permissions:
13
- contents: write
14
- id-token: write
15
-
16
- jobs:
17
-
18
- publish:
19
- name: Publish package to PyPI
20
- runs-on: ubuntu-latest
21
- environment: release
22
- outputs:
23
- released: ${{ steps.release.outputs.released }}
24
- tag: ${{ steps.release.outputs.tag }}
25
- concurrency: release
26
- permissions:
27
- id-token: write
28
- contents: write
29
-
30
- steps:
31
- - name: Checkout repository
32
- uses: actions/checkout@v4
33
- with:
34
- fetch-depth: 0
35
- ref: ${{ github.sha }}
36
-
37
- - name: Force correct release branch on workflow sha
38
- run: |
39
- git checkout -B ${{ github.ref_name }} ${{ github.sha }}
40
-
41
- - name: Python semantic release
42
- id: release
43
- uses: python-semantic-release/python-semantic-release@v9.8.9
44
- with:
45
- build: false
46
- changelog: true
47
- commit: true
48
- push: true
49
- tag: true
50
- github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
51
- git_committer_name: "github-actions[bot]"
52
- git_committer_email: "41898282+github-actions[bot]@users.noreply.github.com"
53
-
54
- - name: Install the latest version of uv
55
- if: steps.release.outputs.released == 'true'
56
- uses: astral-sh/setup-uv@v5
57
- with:
58
- version: "latest"
59
-
60
- - name: Publish package to PyPI with UV
61
- if: steps.release.outputs.released == 'true'
62
- run: |
63
- uv sync --no-dev --group docs
64
- uv build
65
- uv publish
66
-
67
- - name: Publish package distributions to GitHub Releases
68
- uses: python-semantic-release/upload-to-gh-release@v9.8.9
69
- if: steps.release.outputs.released == 'true'
70
- with:
71
- github_token: ${{ secrets.RELEASE_GITHUB_TOKEN }}
72
- tag: ${{ steps.release.outputs.tag }}
73
-
74
- mkdocs:
75
- name: Deploy documentation
76
- needs: [publish]
77
- uses: ./.github/workflows/docs.yaml
78
- secrets: inherit
79
- with:
80
- version: ${{ needs.publish.outputs.tag }}
81
- alias: latest
82
- set-default: true
@@ -1,193 +0,0 @@
1
- # CHANGELOG
2
-
3
- ## v0.4.0 (2025-01-02)
4
-
5
- ### Feature
6
-
7
- * feat: fix workflows (#6)
8
-
9
- * fix workflows
10
-
11
- * set dummy git credentials
12
-
13
- * set permission
14
-
15
- * forgotten input
16
-
17
- * fix
18
-
19
- * fix
20
-
21
- * fix
22
-
23
- * fix
24
-
25
- * fix ([`d90cf92`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d90cf925c992f83bb7102e22981968615310328e))
26
-
27
- * feat: All options working (#4)
28
-
29
- * add general docs
30
-
31
- * add back parameter_headings option
32
-
33
- * improve headings section
34
-
35
- * bump mkdocstrings-python
36
-
37
- * done with headings section
38
-
39
- * fix inherited members, member order
40
-
41
- * better docs
42
-
43
- * fix docstring parameter handling
44
-
45
- * fixes
46
-
47
- * first attempt at hiding hidden and private members
48
-
49
- * working hidden and private members
50
-
51
- * finalize hidden and private members
52
-
53
- * first attempt summaries
54
-
55
- * summaries almost working
56
-
57
- * comments
58
-
59
- * updates
60
-
61
- * merge constructor
62
-
63
- * docs
64
-
65
- * hide previews
66
-
67
- * docstrings section done
68
-
69
- * finalize signatures
70
-
71
- * update logo
72
-
73
- * first attempt at workflows
74
-
75
- * finalize workflow ([`83d1588`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/83d15882e0a00252b91d2d88a19bb2f903674ca4))
76
-
77
- ### Unknown
78
-
79
- * Merge 996e4e9a920c31164f5629b46b444afcc3c626b0 into 27c4fbaf1588a7f0bbd650af31a4ef5910930b07 ([`4909e1f`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/4909e1fa7d6609d6e2eff2a449486077274290a3))
80
-
81
- * match all ([`996e4e9`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/996e4e9a920c31164f5629b46b444afcc3c626b0))
82
-
83
- * fixes ([`7d62914`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/7d62914126ab33d5fb9f80eccf1c984762c3bcf2))
84
-
85
- * fix conf ([`d327dbf`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d327dbfd160bb35da7d1a1d11eb1c4cceb462f1a))
86
-
87
- * Merge branch 'main' into release ([`4f4f744`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/4f4f7442551d03c235b05976f3643d2212b65c56))
88
-
89
- * release (#7) ([`27c4fba`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/27c4fbaf1588a7f0bbd650af31a4ef5910930b07))
90
-
91
- * fix ([`d999d25`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d999d2597b4bde4edd2f8f1770f7023ded4ac85a))
92
-
93
- * release ([`22bb966`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/22bb9665ea8e6f6fc82e664aaf0c16aa812ad37b))
94
-
95
- * release ([`f35fb1d`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/f35fb1d52ff9948bc8bd60f22bc87a01e63f2eef))
96
-
97
- * Create docs.yaml (#5) ([`e3c24ac`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/e3c24ac87548691c4778ba4ea6bf10d6d4e1ddbd))
98
-
99
- ## v0.3.3 (2024-12-19)
100
-
101
- ### Unknown
102
-
103
- * downgrade mkdocstrings-python ([`d520c2b`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/d520c2bf1c62bf844a3b4ba68f6f3cf113975307))
104
-
105
- * bump ([`f147e0a`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/f147e0aa10d02dacadc49cad4c58406525300eef))
106
-
107
- * support Contents.m and readme.md ([`41c3abc`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/41c3abcf272561b3af9d2320658e069249069e90))
108
-
109
- * update logo ([`861f34a`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/861f34ac6ec6b40d8067e2dacd3ad292f7315030))
110
-
111
- * Use tree sitter (#3)
112
-
113
- * parse function
114
-
115
- * parse class
116
-
117
- * add matlab-path
118
-
119
- * restructure
120
-
121
- * working collector
122
-
123
- * collection almost fully
124
-
125
- * working?
126
-
127
- * working
128
-
129
- * working
130
-
131
- * working :)
132
-
133
- * Create parameter documentation from argument blocks
134
-
135
- * fully working
136
-
137
- * use query api for functions
138
-
139
- * fully working
140
-
141
- * uv fixes
142
-
143
- * orginazation
144
-
145
- * improvements
146
-
147
- * labels and symbol name fix via module
148
-
149
- * add pyright config
150
-
151
- * pyright fixes
152
-
153
- * fix method parent
154
-
155
- * add docstrings
156
-
157
- * fixes signature
158
-
159
- * checked all options
160
-
161
- * Finalize ([`6783e67`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/6783e673b4ccb0044a22c6ca462940450ff1a158))
162
-
163
- * Change tool to uv from rye ([`4e97b3f`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/4e97b3fb2dda0a64bdc9d128e9004a2cda1ee1e0))
164
-
165
- * fix size bug ([`6ec7d59`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/6ec7d59e15f8113a482b3bc7b9b4043cac092f25))
166
-
167
- * fix properties ([`9bb1ba3`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/9bb1ba34bd5536fbd06952aa2e469f31c07116b9))
168
-
169
- * small bugfixes ([`83be91e`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/83be91e2be03f5993344d213e20907fba4c95fea))
170
-
171
- * add r2024b support ([`948cd3a`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/948cd3a16b2bc930135ea4bcf2f0a76b4633b0df))
172
-
173
- * Development (#2)
174
-
175
- * fix when paths is empty
176
-
177
- * Add support for inheritance diagrams
178
-
179
- * Finalize inheritance diagram
180
-
181
- * bump version ([`3449226`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/34492263fbf00c400bf3b4f919a5c89d2fc66046))
182
-
183
- * Merge pull request #1 from watermarkhu/development
184
-
185
- Development ([`99cf8d5`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/99cf8d5c65d9d27c18750e7517cc97ffb2098476))
186
-
187
- * fix class ([`89bd1c1`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/89bd1c17a1bb0350c02a2e96b946103a73398332))
188
-
189
- * bump ([`e2ec8f3`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/e2ec8f3b09036833cc6a93e8106cb69fb1c82cd3))
190
-
191
- * Resolve paths relatively to the configuration file ([`6fdda75`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/6fdda75eeb2a78eb0cb7ea864ddea96282eb4ca4))
192
-
193
- * first commit ([`88ea479`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/88ea479b0789dc64818aaa6831e6847941f9ea1a))