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

Sign up to get free protection for your applications and to get access to all the features.
Files changed (75) hide show
  1. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.github/workflows/docs.yaml +2 -1
  2. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.github/workflows/release.yaml +1 -1
  3. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/CHANGELOG.md +8 -0
  4. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/PKG-INFO +3 -3
  5. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/pyproject.toml +1 -1
  6. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/uv.lock +1 -1
  7. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.github/CODEOWNERS +0 -0
  8. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.github/workflows/qualify.yaml +0 -0
  9. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.gitignore +0 -0
  10. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.python-version +0 -0
  11. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.vscode/launch.json +0 -0
  12. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.vscode/settings.json +0 -0
  13. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/LICENSE +0 -0
  14. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/README.md +2 -2
  15. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/changelog.md +0 -0
  16. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/credits.md +0 -0
  17. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/debug.py +0 -0
  18. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/index.md +0 -0
  19. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/license.md +0 -0
  20. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/logo.png +0 -0
  21. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/logo.svg +0 -0
  22. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+module/+submodule/Contents.m +0 -0
  23. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+module/+submodule/subfunction.m +0 -0
  24. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+module/aClass.m +0 -0
  25. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+module/do_something.m +0 -0
  26. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+module/module.md +0 -0
  27. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+module/readme.md +0 -0
  28. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mymembers/BaseClass.m +0 -0
  29. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mymembers/Contents.m +0 -0
  30. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mymembers/ThisClass.m +0 -0
  31. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mymembers/mymembers.md +0 -0
  32. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mymembers/this_function.m +0 -0
  33. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mynamespace/classA.m +0 -0
  34. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mynamespace/classB.m +0 -0
  35. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mynamespace/mynamespace.md +0 -0
  36. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mynamespace/readme.md +0 -0
  37. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+mynamespace/typed_function.m +0 -0
  38. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+undocumented/ClassWithoutDocstring.m +0 -0
  39. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+undocumented/function_with_docstring.m +0 -0
  40. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+undocumented/function_without_docstring.m +0 -0
  41. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/+undocumented/undocumented.md +0 -0
  42. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/Class.m +0 -0
  43. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/OtherClass.m +0 -0
  44. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/Thing.m +0 -0
  45. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/do_output.m +0 -0
  46. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/do_something.m +0 -0
  47. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/do_varargin.m +0 -0
  48. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/myClass.m +0 -0
  49. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/myParent.m +0 -0
  50. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/myfunction.m +0 -0
  51. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/snippets/print_hello.m +0 -0
  52. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/stylesheets/extra.css +0 -0
  53. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/configuration/docstrings.md +0 -0
  54. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/configuration/general.md +0 -0
  55. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/configuration/headings.md +0 -0
  56. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/configuration/members.md +0 -0
  57. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/configuration/signatures.md +0 -0
  58. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/docstrings/google.md +0 -0
  59. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/docstrings/numpy.md +0 -0
  60. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/docstrings/sphinx.md +0 -0
  61. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/docs/usage/index.md +0 -0
  62. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/logo.svg +0 -0
  63. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/mkdocs.yml +0 -0
  64. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/renovate.json +0 -0
  65. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/requirements.lock +0 -0
  66. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocs_material_matlab/__init__.py +0 -0
  67. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocs_material_matlab/css/style.css +0 -0
  68. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocs_material_matlab/mkdocs_material_matlab.py +0 -0
  69. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocstrings_handlers/matlab/__init__.py +0 -0
  70. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocstrings_handlers/matlab/collect.py +0 -0
  71. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocstrings_handlers/matlab/enums.py +0 -0
  72. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocstrings_handlers/matlab/handler.py +0 -0
  73. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocstrings_handlers/matlab/models.py +0 -0
  74. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocstrings_handlers/matlab/py.typed +0 -0
  75. {mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/src/mkdocstrings_handlers/matlab/treesitter.py +0 -0
{mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.github/workflows/docs.yaml RENAMED
@@ -55,7 +55,8 @@ jobs:
55
55
  env:
56
56
  PUSH_DEPLOY: ${{ fromJson(inputs.push) && '--push' || '' }}
57
57
  run: >
58
- uv run mike deploy ${PUSH_DEPLOY}
58
+ uv run mike deploy ${PUSH_DEPLOY}
59
+ --update-aliases
59
60
  --branch gh-pages
60
61
  --alias-type symlink
61
62
  ${{ inputs.version }} ${{ inputs.alias }}
{mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/.github/workflows/release.yaml RENAMED
@@ -83,7 +83,7 @@ jobs:
83
83
  id: publish-dist
84
84
  uses: python-semantic-release/publish-action@v9.15.2
85
85
  with:
86
- github-token: ${{ steps.app-token.outputs.token }}
86
+ github_token: ${{ steps.app-token.outputs.token }}
87
87
  tag: ${{ steps.semantic-release.outputs.tag }}
88
88
 
89
89
  mkdocs:
{mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/CHANGELOG.md RENAMED
@@ -1,6 +1,14 @@
1
1
  # CHANGELOG
2
2
 
3
3
 
4
+ ## v0.5.0 (2025-01-03)
5
+
6
+ ### Features
7
+
8
+ - Force minor release ([#31](https://github.com/watermarkhu/mkdocstrings-matlab/pull/31),
9
+ [`96278d0`](https://github.com/watermarkhu/mkdocstrings-matlab/commit/96278d0ff1080bbb4ac102190653c0fa1a269664))
10
+
11
+
4
12
  ## v0.4.2 (2025-01-03)
5
13
 
6
14
  ### Bug Fixes
{mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/PKG-INFO RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-matlab
3
- Version: 0.4.2
3
+ Version: 0.5.0
4
4
  Summary: A MATLAB handler for mkdocstrings
5
5
  Author-email: Mark Hu <watermarkhu@gmail.com>
6
6
  License: ISC
@@ -32,12 +32,12 @@ Description-Content-Type: text/markdown
32
32
 
33
33
  <p align="center">A MATLAB handler for <a href="https://github.com/mkdocstrings/mkdocstrings"><i>mkdocstrings</i></a>.</p>
34
34
 
35
+ <p align="center"><img width=300px src="logo.svg"></p>
36
+
35
37
  [![qualify](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml/badge.svg)](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml)
36
38
  [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-matlab)
37
39
  [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
38
40
 
39
- <p align="center"><img width=300px src="logo.svg"></p>
40
-
41
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/).
42
42
 
43
43
  ## Installation
{mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/pyproject.toml RENAMED
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mkdocstrings-matlab"
3
- version = "0.4.2"
3
+ version = "0.5.0"
4
4
  description = "A MATLAB handler for mkdocstrings"
5
5
  authors = [
6
6
  { name = "Mark Hu", email = "watermarkhu@gmail.com" }
{mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/uv.lock RENAMED
@@ -979,7 +979,7 @@ wheels = [
979
979
 
980
980
  [[package]]
981
981
  name = "mkdocstrings-matlab"
982
- version = "0.4.2"
982
+ version = "0.5.0"
983
983
  source = { editable = "." }
984
984
  dependencies = [
985
985
  { name = "charset-normalizer" },
{mkdocstrings_matlab-0.4.2 → mkdocstrings_matlab-0.5.0}/README.md RENAMED
@@ -2,12 +2,12 @@
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
+ <p align="center"><img width=300px src="logo.svg"></p>
6
+
5
7
  [![qualify](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml/badge.svg)](https://github.com/watermarkhu/mkdocstrings-matlab/actions/workflows/qualify.yaml)
6
8
  [![documentation](https://img.shields.io/badge/docs-mkdocs-708FCC.svg?style=flat)](https://watermarkhu.nl/mkdocstrings-matlab)
7
9
  [![pypi version](https://img.shields.io/pypi/v/mkdocstrings-matlab.svg)](https://pypi.org/project/mkdocstrings-matlab/)
8
10
 
9
- <p align="center"><img width=300px src="logo.svg"></p>
10
-
11
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/).
12
12
 
13
13
  ## Installation