mkdocstrings-matlab 0.9.5__tar.gz → 0.9.7__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.5 → mkdocstrings_matlab-0.9.7}/.github/workflows/release.yaml +3 -3
  2. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/CHANGELOG.md +33 -0
  3. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/PKG-INFO +2 -2
  4. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/pyproject.toml +3 -3
  5. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/renovate.json +1 -0
  6. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/handler.py +1 -4
  7. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/.github/CODEOWNERS +0 -0
  8. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/.github/workflows/docs.yaml +0 -0
  9. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/.github/workflows/qualify.yaml +0 -0
  10. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/.github/workflows/update-templates.yaml +0 -0
  11. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/.gitignore +0 -0
  12. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/.python-version +0 -0
  13. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/.vscode/launch.json +0 -0
  14. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/.vscode/settings.json +0 -0
  15. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/LICENSE +0 -0
  16. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/README.md +0 -0
  17. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/api.md +0 -0
  18. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/changelog.md +0 -0
  19. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/credits.md +0 -0
  20. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/debug.py +0 -0
  21. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/img/preview_dark.png +0 -0
  22. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/img/preview_light.png +0 -0
  23. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/index.md +0 -0
  24. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/license.md +0 -0
  25. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/logo.png +0 -0
  26. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/logo.svg +0 -0
  27. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/overrides/main.html +0 -0
  28. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/overrides/partials/toc-item.html +0 -0
  29. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+module/+submodule/Contents.m +0 -0
  30. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+module/+submodule/subfunction.m +0 -0
  31. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+module/aClass.m +0 -0
  32. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+module/do_something.m +0 -0
  33. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+module/module.md +0 -0
  34. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+module/readme.md +0 -0
  35. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mymembers/BaseClass.m +0 -0
  36. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mymembers/Contents.m +0 -0
  37. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mymembers/ThisClass.m +0 -0
  38. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mymembers/mymembers.md +0 -0
  39. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mymembers/this_function.m +0 -0
  40. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mynamespace/classA.m +0 -0
  41. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mynamespace/classB.m +0 -0
  42. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mynamespace/mynamespace.md +0 -0
  43. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mynamespace/myscript.m +0 -0
  44. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mynamespace/readme.md +0 -0
  45. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+mynamespace/typed_function.m +0 -0
  46. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+undocumented/ClassWithoutDocstring.m +0 -0
  47. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+undocumented/function_with_docstring.m +0 -0
  48. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+undocumented/function_without_docstring.m +0 -0
  49. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/+undocumented/undocumented.md +0 -0
  50. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/Class.m +0 -0
  51. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/OtherClass.m +0 -0
  52. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/Thing.m +0 -0
  53. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/do_output.m +0 -0
  54. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/do_something.m +0 -0
  55. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/do_varargin.m +0 -0
  56. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/myClass.m +0 -0
  57. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/myParent.m +0 -0
  58. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/myfunction.m +0 -0
  59. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/snippets/print_hello.m +0 -0
  60. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/stylesheets/extra.css +0 -0
  61. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/configuration/docstrings.md +0 -0
  62. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/configuration/general.md +0 -0
  63. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/configuration/headings.md +0 -0
  64. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/configuration/members.md +0 -0
  65. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/configuration/signatures.md +0 -0
  66. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/docstrings/google.md +0 -0
  67. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/docstrings/numpy.md +0 -0
  68. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/docstrings/sphinx.md +0 -0
  69. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/docs/usage/index.md +0 -0
  70. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/logo.svg +0 -0
  71. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/mkdocs.yml +0 -0
  72. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/requirements.lock +0 -0
  73. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/scripts/copy_and_update_python_templates.py +0 -0
  74. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/__init__.py +0 -0
  75. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/collect.py +0 -0
  76. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/enums.py +0 -0
  77. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/models.py +0 -0
  78. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/py.typed +0 -0
  79. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/children.html.jinja +0 -0
  80. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja +0 -0
  81. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja +0 -0
  82. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/folder.html.jinja +0 -0
  83. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja +0 -0
  84. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/property.html.jinja +0 -0
  85. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/script.html.jinja +0 -0
  86. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/style.css +0 -0
  87. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja +0 -0
  88. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja +0 -0
  89. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/templates/material/summary.html.jinja +0 -0
  90. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/src/mkdocstrings_handlers/matlab/treesitter.py +0 -0
  91. {mkdocstrings_matlab-0.9.5 → mkdocstrings_matlab-0.9.7}/test/playground.py +0 -0
@@ -65,7 +65,7 @@ jobs:
65
65
 
66
66
  steps:
67
67
 
68
- - uses: actions/create-github-app-token@v1
68
+ - uses: actions/create-github-app-token@v2
69
69
  id: app-token
70
70
  with:
71
71
  app-id: ${{ vars.APP_ID }}
@@ -95,7 +95,7 @@ jobs:
95
95
 
96
96
  - name: Update version and changelogs
97
97
  id: semantic-release
98
- uses: python-semantic-release/python-semantic-release@v9.17.0
98
+ uses: python-semantic-release/python-semantic-release@v9.21.0
99
99
  with:
100
100
  build: false
101
101
  changelog: true
@@ -121,7 +121,7 @@ jobs:
121
121
  - name: Publish package distributions to GitHub Releases
122
122
  if: steps.semantic-release.outputs.released == 'true'
123
123
  id: publish-dist
124
- uses: python-semantic-release/publish-action@v9.17.0
124
+ uses: python-semantic-release/publish-action@v9.21.0
125
125
  with:
126
126
  github_token: ${{ steps.app-token.outputs.token }}
127
127
  tag: ${{ steps.semantic-release.outputs.tag }}
@@ -1,6 +1,39 @@
1
1
  # CHANGELOG
2
2
 
3
3
 
4
+ ## v0.9.7 (2025-05-03)
5
+
6
+ ### Bug Fixes
7
+
8
+ - Handler config ([#84](https://github.com/watermarkhu/mkdocstrings-matlab/pull/84),
9
+ [`51c6fda`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/51c6fda399b6a2abf18c6ffa3298bfae167315aa))
10
+
11
+ ### Chores
12
+
13
+ - **deps**: Update actions/create-github-app-token action to v2
14
+ ([#80](https://github.com/watermarkhu/mkdocstrings-matlab/pull/80),
15
+ [`e9e6899`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/e9e689916e368d9c12f552f22445423888fb651d))
16
+
17
+ Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
18
+
19
+ - **deps**: Update group-github-actions to v9.21.0
20
+ ([#75](https://github.com/watermarkhu/mkdocstrings-matlab/pull/75),
21
+ [`f4c14e3`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/f4c14e321e12d84e79dc7d9da0e3f877921521c7))
22
+
23
+ Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
24
+
25
+
26
+ ## v0.9.6 (2025-02-14)
27
+
28
+ ### Bug Fixes
29
+
30
+ - **deps**: Update dependency mkdocstrings to v0.28.0
31
+ ([#70](https://github.com/watermarkhu/mkdocstrings-matlab/pull/70),
32
+ [`5b512ab`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/5b512abd5656187ad888f5edf4a99aa9bff24141))
33
+
34
+ Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
35
+
36
+
4
37
  ## v0.9.5 (2025-02-02)
5
38
 
6
39
  ### Bug Fixes
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-matlab
3
- Version: 0.9.5
3
+ Version: 0.9.7
4
4
  Summary: A MATLAB handler for mkdocstrings
5
5
  Author-email: Mark Hu <watermarkhu@gmail.com>
6
6
  License: MIT
@@ -23,7 +23,7 @@ Classifier: Typing :: Typed
23
23
  Requires-Python: >=3.10
24
24
  Requires-Dist: charset-normalizer==3.4.1
25
25
  Requires-Dist: mkdocstrings-python==1.13.0
26
- Requires-Dist: mkdocstrings==0.27.0
26
+ Requires-Dist: mkdocstrings==0.28.0
27
27
  Requires-Dist: tree-sitter-matlab==1.0.4
28
28
  Requires-Dist: tree-sitter==0.24.0
29
29
  Description-Content-Type: text/markdown
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mkdocstrings-matlab"
3
- version = "0.9.5"
3
+ version = "0.9.7"
4
4
  description = "A MATLAB handler for mkdocstrings"
5
5
  authors = [
6
6
  { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -9,7 +9,7 @@ license = { text = "MIT" }
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
11
11
  dependencies = [
12
- "mkdocstrings==0.27.0",
12
+ "mkdocstrings==0.28.0",
13
13
  "mkdocstrings-python==1.13.0",
14
14
  "charset-normalizer==3.4.1",
15
15
  "tree-sitter==0.24.0",
@@ -114,7 +114,7 @@ default = "semantic-release <semantic-release>"
114
114
 
115
115
  [tool.semantic_release.commit_parser_options]
116
116
  minor_tags = ["feat"]
117
- patch_tags = ["fix", "perf"]
117
+ patch_tags = ["fix", "perf", "patch"]
118
118
  other_allowed_tags = ["build", "chore", "ci", "docs", "style", "refactor", "test"]
119
119
  allowed_tags = ["feat", "fix", "perf", "build", "chore", "ci", "docs", "style", "refactor", "test"]
120
120
  default_bump_level = 0
@@ -6,6 +6,7 @@
6
6
  "branchPrefix": "renovate-",
7
7
  "packageRules": [
8
8
  {
9
+ "groupName": "group-github-actions",
9
10
  "description": "Group GitHub Action updates",
10
11
  "matchManagers": ["github-actions"]
11
12
  }
@@ -377,8 +377,6 @@ def get_handler(
377
377
  theme: str,
378
378
  custom_templates: str | None = None,
379
379
  config_file_path: str | None = None,
380
- paths: list[str] | None = None,
381
- paths_recursive: bool = False,
382
380
  **config: Any,
383
381
  ) -> MatlabHandler:
384
382
  """
@@ -400,8 +398,7 @@ def get_handler(
400
398
  theme=theme,
401
399
  custom_templates=custom_templates,
402
400
  config_file_path=config_file_path,
403
- paths=paths,
404
- paths_recursive=paths_recursive,
401
+ **config['handler_config']
405
402
  )
406
403
 
407
404