mkdocstrings-matlab 0.4.1__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 (75) hide show
  1. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/.github/workflows/release.yaml +23 -30
  2. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/CHANGELOG.md +15 -0
  3. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/PKG-INFO +2 -2
  4. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/README.md +1 -1
  5. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/pyproject.toml +1 -1
  6. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/uv.lock +4 -4
  7. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/.github/CODEOWNERS +0 -0
  8. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/.github/workflows/docs.yaml +0 -0
  9. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/.github/workflows/qualify.yaml +0 -0
  10. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/.gitignore +0 -0
  11. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/.python-version +0 -0
  12. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/.vscode/launch.json +0 -0
  13. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/.vscode/settings.json +0 -0
  14. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/LICENSE +0 -0
  15. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/changelog.md +0 -0
  16. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/credits.md +0 -0
  17. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/debug.py +0 -0
  18. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/index.md +0 -0
  19. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/license.md +0 -0
  20. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/logo.png +0 -0
  21. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/logo.svg +0 -0
  22. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/+submodule/Contents.m +0 -0
  23. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/+submodule/subfunction.m +0 -0
  24. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/aClass.m +0 -0
  25. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/do_something.m +0 -0
  26. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/module.md +0 -0
  27. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+module/readme.md +0 -0
  28. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/BaseClass.m +0 -0
  29. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/Contents.m +0 -0
  30. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/ThisClass.m +0 -0
  31. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/mymembers.md +0 -0
  32. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mymembers/this_function.m +0 -0
  33. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/classA.m +0 -0
  34. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/classB.m +0 -0
  35. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/mynamespace.md +0 -0
  36. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/readme.md +0 -0
  37. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+mynamespace/typed_function.m +0 -0
  38. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+undocumented/ClassWithoutDocstring.m +0 -0
  39. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+undocumented/function_with_docstring.m +0 -0
  40. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+undocumented/function_without_docstring.m +0 -0
  41. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/+undocumented/undocumented.md +0 -0
  42. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/Class.m +0 -0
  43. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/OtherClass.m +0 -0
  44. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/Thing.m +0 -0
  45. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/do_output.m +0 -0
  46. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/do_something.m +0 -0
  47. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/do_varargin.m +0 -0
  48. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/myClass.m +0 -0
  49. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/myParent.m +0 -0
  50. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/myfunction.m +0 -0
  51. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/snippets/print_hello.m +0 -0
  52. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/stylesheets/extra.css +0 -0
  53. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/docstrings.md +0 -0
  54. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/general.md +0 -0
  55. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/headings.md +0 -0
  56. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/members.md +0 -0
  57. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/configuration/signatures.md +0 -0
  58. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/docstrings/google.md +0 -0
  59. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/docstrings/numpy.md +0 -0
  60. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/docstrings/sphinx.md +0 -0
  61. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/docs/usage/index.md +0 -0
  62. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/logo.svg +0 -0
  63. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/mkdocs.yml +0 -0
  64. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/renovate.json +0 -0
  65. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/requirements.lock +0 -0
  66. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocs_material_matlab/__init__.py +0 -0
  67. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocs_material_matlab/css/style.css +0 -0
  68. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocs_material_matlab/mkdocs_material_matlab.py +0 -0
  69. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/__init__.py +0 -0
  70. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/collect.py +0 -0
  71. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/enums.py +0 -0
  72. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/handler.py +0 -0
  73. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/models.py +0 -0
  74. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/py.typed +0 -0
  75. {mkdocstrings_matlab-0.4.1 → mkdocstrings_matlab-0.4.2}/src/mkdocstrings_handlers/matlab/treesitter.py +0 -0
@@ -16,8 +16,8 @@ jobs:
16
16
  runs-on: ubuntu-latest
17
17
  environment: release
18
18
  outputs:
19
- released: ${{ steps.release.outputs.released }}
20
- tag: ${{ steps.release.outputs.tag }}
19
+ released: ${{ steps.semantic-release.outputs.released }}
20
+ tag: ${{ steps.semantic-release.outputs.tag }}
21
21
  concurrency: release
22
22
  permissions:
23
23
  id-token: write
@@ -25,7 +25,6 @@ jobs:
25
25
 
26
26
  steps:
27
27
 
28
-
29
28
  - uses: actions/create-github-app-token@v1
30
29
  id: app-token
31
30
  with:
@@ -54,44 +53,38 @@ jobs:
54
53
  run: |
55
54
  git checkout -B ${{ github.ref_name }} ${{ github.sha }}
56
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
+
57
68
  - name: Install the latest version of uv
69
+ if: steps.semantic-release.outputs.released == 'true'
58
70
  uses: astral-sh/setup-uv@v5
59
71
  with:
60
72
  version: "latest"
61
73
 
62
- - name: Setup environment with UV
63
- run: |
64
- uv sync --dev
65
- CURRENT_VERSION=$(uv run semantic-release --noop version --print-last-released)
66
- NEXT_VERSION=$(uv run semantic-release --noop version --print)
67
-
68
- if [ "$CURRENT_VERSION" = "$NEXT_VERSION" ]; then
69
- echo "deploy=false" >> $GITHUB_ENV
70
- else
71
- echo "deploy=true" >> $GITHUB_ENV
72
- fi
73
-
74
- - name: Update version and changelogs
75
- if: env.deploy
76
- env:
77
- GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
78
- run: >
79
- uv run semantic-release -vv version
80
- --commit --tag --changelog --push
81
- --skip-build --no-vcs-release
82
-
83
74
  - name: Build and publish package distributions
84
- if: env.deploy
75
+ if: steps.semantic-release.outputs.released == 'true'
85
76
  run: |
77
+ uv sync --no-dev
86
78
  uv build
87
79
  uv publish
88
80
 
89
81
  - name: Publish package distributions to GitHub Releases
90
- if: env.deploy
91
- env:
92
- GITHUB_TOKEN: ${{ steps.app-token.outputs.token }}
93
- run: |
94
- uv run semantic-release -vv publish
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 }}
95
88
 
96
89
  mkdocs:
97
90
  name: Deploy documentation
@@ -1,6 +1,21 @@
1
1
  # CHANGELOG
2
2
 
3
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
+
4
19
  ## v0.4.1 (2025-01-03)
5
20
 
6
21
  ### Bug Fixes
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-matlab
3
- Version: 0.4.1
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
@@ -49,7 +49,7 @@ You can install this handler by specifying it as a dependency:
49
49
  # adapt to your dependencies manager
50
50
  [project]
51
51
  dependencies = [
52
- "mkdocstrings-matlab>=0.4.0",
52
+ "mkdocstrings-matlab>=0.X.Y",
53
53
  ]
54
54
  ```
55
55
 
@@ -19,7 +19,7 @@ You can install this handler by specifying it as a dependency:
19
19
  # adapt to your dependencies manager
20
20
  [project]
21
21
  dependencies = [
22
- "mkdocstrings-matlab>=0.4.0",
22
+ "mkdocstrings-matlab>=0.X.Y",
23
23
  ]
24
24
  ```
25
25
 
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mkdocstrings-matlab"
3
- version = "0.4.1"
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" }
@@ -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,7 +979,7 @@ 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" },