mkdocstrings-matlab 0.9.0__tar.gz → 0.9.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (91) hide show
  1. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.github/workflows/release.yaml +41 -42
  2. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/CHANGELOG.md +26 -0
  3. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/PKG-INFO +2 -2
  4. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/pyproject.toml +2 -2
  5. mkdocstrings_matlab-0.9.2/renovate.json +13 -0
  6. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/handler.py +1 -1
  7. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/style.css +2 -2
  8. mkdocstrings_matlab-0.9.0/renovate.json +0 -6
  9. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.github/CODEOWNERS +0 -0
  10. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.github/workflows/docs.yaml +0 -0
  11. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.github/workflows/qualify.yaml +0 -0
  12. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.github/workflows/update-templates.yaml +0 -0
  13. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.gitignore +0 -0
  14. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.python-version +0 -0
  15. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.vscode/launch.json +0 -0
  16. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/.vscode/settings.json +0 -0
  17. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/LICENSE +0 -0
  18. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/README.md +0 -0
  19. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/api.md +0 -0
  20. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/changelog.md +0 -0
  21. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/credits.md +0 -0
  22. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/debug.py +0 -0
  23. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/img/preview_dark.png +0 -0
  24. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/img/preview_light.png +0 -0
  25. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/index.md +0 -0
  26. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/license.md +0 -0
  27. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/logo.png +0 -0
  28. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/logo.svg +0 -0
  29. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/overrides/main.html +0 -0
  30. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/overrides/partials/toc-item.html +0 -0
  31. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+module/+submodule/Contents.m +0 -0
  32. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+module/+submodule/subfunction.m +0 -0
  33. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+module/aClass.m +0 -0
  34. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+module/do_something.m +0 -0
  35. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+module/module.md +0 -0
  36. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+module/readme.md +0 -0
  37. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mymembers/BaseClass.m +0 -0
  38. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mymembers/Contents.m +0 -0
  39. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mymembers/ThisClass.m +0 -0
  40. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mymembers/mymembers.md +0 -0
  41. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mymembers/this_function.m +0 -0
  42. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mynamespace/classA.m +0 -0
  43. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mynamespace/classB.m +0 -0
  44. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mynamespace/mynamespace.md +0 -0
  45. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mynamespace/myscript.m +0 -0
  46. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mynamespace/readme.md +0 -0
  47. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+mynamespace/typed_function.m +0 -0
  48. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+undocumented/ClassWithoutDocstring.m +0 -0
  49. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+undocumented/function_with_docstring.m +0 -0
  50. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+undocumented/function_without_docstring.m +0 -0
  51. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/+undocumented/undocumented.md +0 -0
  52. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/Class.m +0 -0
  53. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/OtherClass.m +0 -0
  54. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/Thing.m +0 -0
  55. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/do_output.m +0 -0
  56. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/do_something.m +0 -0
  57. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/do_varargin.m +0 -0
  58. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/myClass.m +0 -0
  59. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/myParent.m +0 -0
  60. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/myfunction.m +0 -0
  61. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/snippets/print_hello.m +0 -0
  62. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/stylesheets/extra.css +0 -0
  63. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/configuration/docstrings.md +0 -0
  64. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/configuration/general.md +0 -0
  65. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/configuration/headings.md +0 -0
  66. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/configuration/members.md +0 -0
  67. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/configuration/signatures.md +0 -0
  68. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/docstrings/google.md +0 -0
  69. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/docstrings/numpy.md +0 -0
  70. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/docstrings/sphinx.md +0 -0
  71. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/docs/usage/index.md +0 -0
  72. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/logo.svg +0 -0
  73. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/mkdocs.yml +0 -0
  74. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/requirements.lock +0 -0
  75. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/scripts/copy_and_update_python_templates.py +0 -0
  76. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/__init__.py +0 -0
  77. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/collect.py +0 -0
  78. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/enums.py +0 -0
  79. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/models.py +0 -0
  80. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/py.typed +0 -0
  81. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/children.html.jinja +0 -0
  82. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja +0 -0
  83. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja +0 -0
  84. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/folder.html.jinja +0 -0
  85. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja +0 -0
  86. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/property.html.jinja +0 -0
  87. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/script.html.jinja +0 -0
  88. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja +0 -0
  89. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja +0 -0
  90. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/templates/material/summary.html.jinja +0 -0
  91. {mkdocstrings_matlab-0.9.0 → mkdocstrings_matlab-0.9.2}/src/mkdocstrings_handlers/matlab/treesitter.py +0 -0
@@ -10,6 +10,45 @@ permissions:
10
10
  id-token: write
11
11
 
12
12
  jobs:
13
+ delete-test-document:
14
+ name: Delete test documentation
15
+ runs-on: ubuntu-latest
16
+ concurrency:
17
+ group: gh-pages
18
+ cancel-in-progress: false
19
+
20
+ steps:
21
+ - name: checkout repository
22
+ uses: actions/checkout@v4
23
+ with:
24
+ fetch-depth: 0 # Required to push to the documentation branch
25
+
26
+ - name: Install the latest version of uv
27
+ uses: astral-sh/setup-uv@v5
28
+ with:
29
+ version: "latest"
30
+
31
+ - name: Sync dependencies
32
+ run: |
33
+ uv sync --no-dev --group docs
34
+
35
+ - name: Configure Git Credentials
36
+ run: |
37
+ git config --global user.name github-actions[bot]
38
+ git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
39
+ git fetch origin gh-pages:gh-pages
40
+
41
+ - name: delete testing documentation
42
+ continue-on-error: true
43
+ env:
44
+ VERSION: ${{ format('pr-{0}', github.head_ref) || 'test' }}
45
+ run: >
46
+ uv run mike delete
47
+ --push --ignore-remote-status
48
+ --config-file mkdocs.yml
49
+ --branch gh-pages
50
+ $VERSION
51
+
13
52
  publish:
14
53
  if: github.event.pull_request.merged == true
15
54
  name: Semantic version release
@@ -55,7 +94,7 @@ jobs:
55
94
 
56
95
  - name: Update version and changelogs
57
96
  id: semantic-release
58
- uses: python-semantic-release/python-semantic-release@v9.16.1
97
+ uses: python-semantic-release/python-semantic-release@v9.17.0
59
98
  with:
60
99
  build: false
61
100
  changelog: true
@@ -81,51 +120,11 @@ jobs:
81
120
  - name: Publish package distributions to GitHub Releases
82
121
  if: steps.semantic-release.outputs.released == 'true'
83
122
  id: publish-dist
84
- uses: python-semantic-release/publish-action@v9.16.1
123
+ uses: python-semantic-release/publish-action@v9.17.0
85
124
  with:
86
125
  github_token: ${{ steps.app-token.outputs.token }}
87
126
  tag: ${{ steps.semantic-release.outputs.tag }}
88
127
 
89
- delete-test-document:
90
- name: Delete test documentation
91
- needs: publish
92
- runs-on: ubuntu-latest
93
- concurrency:
94
- group: gh-pages
95
- cancel-in-progress: false
96
-
97
- steps:
98
- - name: checkout repository
99
- uses: actions/checkout@v4
100
- with:
101
- fetch-depth: 0 # Required to push to the documentation branch
102
-
103
- - name: Install the latest version of uv
104
- uses: astral-sh/setup-uv@v5
105
- with:
106
- version: "latest"
107
-
108
- - name: Sync dependencies
109
- run: |
110
- uv sync --no-dev --group docs
111
-
112
- - name: Configure Git Credentials
113
- run: |
114
- git config --global user.name github-actions[bot]
115
- git config --global user.email 41898282+github-actions[bot]@users.noreply.github.com
116
- git fetch origin gh-pages:gh-pages
117
-
118
- - name: delete testing documentation
119
- continue-on-error: true
120
- env:
121
- VERSION: ${{ format('pr-{0}', github.head_ref) || 'test' }}
122
- run: >
123
- uv run mike delete
124
- --push --ignore-remote-status
125
- --config-file mkdocs.yml
126
- --branch gh-pages
127
- $VERSION
128
-
129
128
  mkdocs:
130
129
  name: Deploy documentation
131
130
  needs: [publish, delete-test-document]
@@ -1,6 +1,32 @@
1
1
  # CHANGELOG
2
2
 
3
3
 
4
+ ## v0.9.2 (2025-01-26)
5
+
6
+ ### Bug Fixes
7
+
8
+ - **deps**: Update deps ([#59](https://github.com/watermarkhu/mkdocstrings-matlab/pull/59),
9
+ [`131c30c`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/131c30ca6046a85def35f37f5f2a3d48e9815f2d))
10
+
11
+ * chore(deps): update python-semantic-release/python-semantic-release action to v9.17.0 (#55)
12
+
13
+ Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
14
+
15
+ * chore(deps): update python-semantic-release/publish-action action to v9.17.0 (#54)
16
+
17
+ * fix(deps): update dependency tree-sitter to v0.24.0 (#53)
18
+
19
+ ---------
20
+
21
+
22
+ ## v0.9.1 (2025-01-16)
23
+
24
+ ### Bug Fixes
25
+
26
+ - Config path resolve ([#52](https://github.com/watermarkhu/mkdocstrings-matlab/pull/52),
27
+ [`710832b`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/710832b12d6371d9f5bba5578c4e3a555fe8a38d))
28
+
29
+
4
30
  ## v0.9.0 (2025-01-16)
5
31
 
6
32
  ### Features
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-matlab
3
- Version: 0.9.0
3
+ Version: 0.9.2
4
4
  Summary: A MATLAB handler for mkdocstrings
5
5
  Author-email: Mark Hu <watermarkhu@gmail.com>
6
6
  License: MIT
@@ -25,7 +25,7 @@ Requires-Dist: charset-normalizer==3.4.1
25
25
  Requires-Dist: mkdocstrings-python==1.13.0
26
26
  Requires-Dist: mkdocstrings==0.27.0
27
27
  Requires-Dist: tree-sitter-matlab==1.0.3
28
- Requires-Dist: tree-sitter==0.23.2
28
+ Requires-Dist: tree-sitter==0.24.0
29
29
  Description-Content-Type: text/markdown
30
30
 
31
31
  <!-- --8<-- [start:header] -->
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mkdocstrings-matlab"
3
- version = "0.9.0"
3
+ version = "0.9.2"
4
4
  description = "A MATLAB handler for mkdocstrings"
5
5
  authors = [
6
6
  { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -12,7 +12,7 @@ dependencies = [
12
12
  "mkdocstrings==0.27.0",
13
13
  "mkdocstrings-python==1.13.0",
14
14
  "charset-normalizer==3.4.1",
15
- "tree-sitter==0.23.2",
15
+ "tree-sitter==0.24.0",
16
16
  "tree-sitter-matlab==1.0.3",
17
17
  ]
18
18
  classifiers = [
@@ -0,0 +1,13 @@
1
+ {
2
+ "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3
+ "extends": [
4
+ "config:recommended"
5
+ ],
6
+ "branchPrefix": "renovate-",
7
+ "packageRules": [
8
+ {
9
+ "description": "Group GitHub Action updates",
10
+ "matchManagers": ["github-actions"]
11
+ }
12
+ ]
13
+ }
@@ -193,7 +193,7 @@ class MatlabHandler(BaseHandler):
193
193
  config_path = None
194
194
  full_paths = []
195
195
  else:
196
- config_path = Path(config_file_path).parent
196
+ config_path = Path(config_file_path).resolve().parent
197
197
  full_paths = [(config_path / path).resolve() for path in paths]
198
198
 
199
199
  if pathIds := [str(path) for path in full_paths if not path.is_dir()]:
@@ -27,9 +27,9 @@ code.doc-symbol-property::after {
27
27
 
28
28
  code.doc-symbol-script {
29
29
  color: #d0bf3d;
30
- background-color: #fff8a87b;
30
+ background-color: #96862f27;
31
31
  }
32
32
 
33
33
  code.doc-symbol-script::after {
34
- content: "prog";
34
+ content: "script";
35
35
  }
@@ -1,6 +0,0 @@
1
- {
2
- "$schema": "https://docs.renovatebot.com/renovate-schema.json",
3
- "extends": [
4
- "config:recommended"
5
- ]
6
- }