mkdocstrings-matlab 0.3.1__tar.gz → 0.3.3__tar.gz

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/PKG-INFO +4 -3
  2. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/pyproject.toml +4 -3
  3. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocstrings_handlers/matlab/collect.py +1 -1
  4. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocstrings_handlers/matlab/handler.py +5 -2
  5. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/.gitignore +0 -0
  6. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/.python-version +0 -0
  7. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/.vscode/launch.json +0 -0
  8. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/.vscode/settings.json +0 -0
  9. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/LICENSE +0 -0
  10. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/README.md +0 -0
  11. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/docs/index.md +0 -0
  12. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/docs/license.md +0 -0
  13. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/docs/logo.png +0 -0
  14. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/docs/stylesheets/extra.css +0 -0
  15. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/docs/usage/docstrings/google.md +0 -0
  16. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/docs/usage/docstrings/numpy.md +0 -0
  17. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/docs/usage/docstrings/sphinx.md +0 -0
  18. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/docs/usage/index.md +0 -0
  19. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/logo.png +0 -0
  20. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/mkdocs.yml +0 -0
  21. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/requirements.lock +0 -0
  22. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocs_material_matlab/__init__.py +0 -0
  23. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocs_material_matlab/css/style.css +0 -0
  24. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocs_material_matlab/mkdocs_material_matlab.py +0 -0
  25. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocstrings_handlers/matlab/__init__.py +0 -0
  26. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocstrings_handlers/matlab/enums.py +0 -0
  27. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocstrings_handlers/matlab/models.py +0 -0
  28. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocstrings_handlers/matlab/py.typed +0 -0
  29. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/src/mkdocstrings_handlers/matlab/treesitter.py +0 -0
  30. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/debug.py +0 -0
  31. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/docs/api.md +0 -0
  32. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/docs/index.md +0 -0
  33. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/docs/namespace.md +0 -0
  34. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/mkdocs.yml +0 -0
  35. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/src/+myNamespace/+subpackage/nested.m +0 -0
  36. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/src/+myNamespace/@myClass/customMethod.m +0 -0
  37. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/src/+myNamespace/@myClass/myClass.m +0 -0
  38. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/src/+myNamespace/namespacefunction.m +0 -0
  39. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/src/AbstractFramework.m +0 -0
  40. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/src/DocumentationFramework.m +0 -0
  41. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/test/src/myfunction.m +0 -0
  42. {mkdocstrings_matlab-0.3.1 → mkdocstrings_matlab-0.3.3}/uv.lock +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: mkdocstrings-matlab
3
- Version: 0.3.1
3
+ Version: 0.3.3
4
4
  Summary: A MATLAB handler for mkdocstrings
5
5
  Author-email: Mark Hu <watermarkhu@gmail.com>
6
6
  License: ISC
@@ -23,8 +23,9 @@ Classifier: Typing :: Typed
23
23
  Requires-Python: >=3.10
24
24
  Requires-Dist: charset-normalizer>=3.3.2
25
25
  Requires-Dist: griffe>=1.5.1
26
- Requires-Dist: mkdocs>=1.6.0
27
- Requires-Dist: mkdocstrings[python]>=0.18
26
+ Requires-Dist: mkdocs==1.6.1
27
+ Requires-Dist: mkdocstrings-python==1.10.9
28
+ Requires-Dist: mkdocstrings==0.27.0
28
29
  Requires-Dist: tree-sitter-matlab>=1.0.2
29
30
  Requires-Dist: tree-sitter>=0.23.2
30
31
  Description-Content-Type: text/markdown
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "mkdocstrings-matlab"
3
- version = "0.3.1"
3
+ version = "0.3.3"
4
4
  description = "A MATLAB handler for mkdocstrings"
5
5
  authors = [
6
6
  { name = "Mark Hu", email = "watermarkhu@gmail.com" }
@@ -9,8 +9,9 @@ license = { text = "ISC" }
9
9
  readme = "README.md"
10
10
  requires-python = ">=3.10"
11
11
  dependencies = [
12
- "mkdocs>=1.6.0",
13
- "mkdocstrings[python]>=0.18",
12
+ "mkdocs==1.6.1",
13
+ "mkdocstrings==0.27.0",
14
+ "mkdocstrings-python==1.10.9", # Later versions will currently break
14
15
  "charset-normalizer>=3.3.2",
15
16
  "griffe>=1.5.1",
16
17
  "tree-sitter>=0.23.2",
@@ -200,7 +200,7 @@ class PathCollection(ModulesCollection):
200
200
  return model
201
201
  return None
202
202
 
203
- def update_model(self, model: MatlabMixin, config: Mapping):
203
+ def update_model(self, model: MatlabMixin, config: Mapping) -> MatlabMixin:
204
204
  """
205
205
  Update the given model based on the provided configuration.
206
206
 
@@ -21,7 +21,10 @@ class MatlabHandler(BaseHandler):
21
21
  """Whether this handler is interested in enabling the creation of the `objects.inv` Sphinx inventory file."""
22
22
  fallback_theme = "material"
23
23
  """The fallback theme."""
24
- fallback_config: ClassVar[dict] = {"fallback": True}
24
+ fallback_config: ClassVar[dict] = {
25
+ "fallback": True,
26
+ "merge_constructor_into_class": True,
27
+ }
25
28
  """The configuration used to collect item during autorefs fallback."""
26
29
  default_config: ClassVar[dict] = {
27
30
  # General options
@@ -51,7 +54,7 @@ class MatlabHandler(BaseHandler):
51
54
  "docstring_options": {},
52
55
  "docstring_section_style": "table",
53
56
  "create_from_argument_blocks": False,
54
- "merge_constructor_into_class": False,
57
+ "merge_constructor_into_class": True,
55
58
  "show_if_no_docstring": False,
56
59
  "show_docstring_attributes": True,
57
60
  "show_docstring_functions": True,