mkdocstrings-matlab 0.9.7__py3-none-any.whl → 1.0.1__py3-none-any.whl
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.
- mkdocstrings_handlers/matlab/__init__.py +26 -3
- mkdocstrings_handlers/matlab/config.py +885 -0
- mkdocstrings_handlers/matlab/handler.py +155 -296
- mkdocstrings_handlers/matlab/logger.py +111 -0
- mkdocstrings_handlers/matlab/rendering.py +818 -0
- mkdocstrings_handlers/matlab/templates/material/attributes.html.jinja +25 -0
- mkdocstrings_handlers/matlab/templates/material/backlinks.html.jinja +17 -0
- mkdocstrings_handlers/matlab/templates/material/children.html.jinja +70 -62
- mkdocstrings_handlers/matlab/templates/material/class.html.jinja +236 -0
- mkdocstrings_handlers/matlab/templates/material/docstring/admonition.html.jinja +20 -0
- mkdocstrings_handlers/matlab/templates/material/docstring/classes.html.jinja +85 -0
- mkdocstrings_handlers/matlab/templates/material/docstring/examples.html.jinja +27 -0
- mkdocstrings_handlers/matlab/templates/material/docstring/functions.html.jinja +91 -0
- mkdocstrings_handlers/matlab/templates/material/docstring/input_arguments.html.jinja +171 -0
- mkdocstrings_handlers/matlab/templates/material/docstring/name_value_arguments.html.jinja +166 -0
- mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja +5 -6
- mkdocstrings_handlers/matlab/templates/material/docstring/output_arguments.html.jinja +152 -0
- mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja +25 -26
- mkdocstrings_handlers/matlab/templates/material/docstring.html.jinja +53 -0
- mkdocstrings_handlers/matlab/templates/material/expression.html.jinja +55 -0
- mkdocstrings_handlers/matlab/templates/material/folder.html.jinja +31 -39
- mkdocstrings_handlers/matlab/templates/material/function.html.jinja +148 -0
- mkdocstrings_handlers/matlab/templates/material/language.html.jinja +18 -0
- mkdocstrings_handlers/matlab/templates/material/languages/en.html.jinja +38 -0
- mkdocstrings_handlers/matlab/templates/material/languages/ja.html.jinja +38 -0
- mkdocstrings_handlers/matlab/templates/material/languages/zh.html.jinja +38 -0
- mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja +32 -38
- mkdocstrings_handlers/matlab/templates/material/property.html.jinja +39 -35
- mkdocstrings_handlers/matlab/templates/material/script.html.jinja +3 -25
- mkdocstrings_handlers/matlab/templates/material/signature.html.jinja +105 -0
- mkdocstrings_handlers/matlab/templates/material/style.css +179 -4
- mkdocstrings_handlers/matlab/templates/material/summary/classes.html.jinja +25 -0
- mkdocstrings_handlers/matlab/templates/material/summary/functions.html.jinja +25 -0
- mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja +17 -13
- mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja +17 -13
- mkdocstrings_handlers/matlab/templates/material/summary.html.jinja +6 -6
- {mkdocstrings_matlab-0.9.7.dist-info → mkdocstrings_matlab-1.0.1.dist-info}/METADATA +17 -21
- mkdocstrings_matlab-1.0.1.dist-info/RECORD +41 -0
- mkdocstrings_handlers/matlab/collect.py +0 -783
- mkdocstrings_handlers/matlab/enums.py +0 -54
- mkdocstrings_handlers/matlab/models.py +0 -633
- mkdocstrings_handlers/matlab/treesitter.py +0 -707
- mkdocstrings_matlab-0.9.7.dist-info/RECORD +0 -22
- {mkdocstrings_matlab-0.9.7.dist-info → mkdocstrings_matlab-1.0.1.dist-info}/WHEEL +0 -0
- {mkdocstrings_matlab-0.9.7.dist-info → mkdocstrings_matlab-1.0.1.dist-info}/licenses/LICENSE +0 -0
@@ -1,12 +1,21 @@
|
|
1
1
|
"""MATLAB handler for mkdocstrings."""
|
2
2
|
|
3
|
+
from __future__ import annotations
|
4
|
+
|
5
|
+
import logging
|
6
|
+
|
3
7
|
from _griffe.docstrings import google, numpy
|
4
8
|
from _griffe.enumerations import DocstringSectionKind
|
5
9
|
|
6
|
-
from mkdocstrings_handlers.matlab import
|
7
|
-
from mkdocstrings_handlers.matlab.handler import get_handler
|
10
|
+
from mkdocstrings_handlers.matlab.config import MatlabConfig, MatlabOptions
|
11
|
+
from mkdocstrings_handlers.matlab.handler import MatlabHandler, get_handler
|
8
12
|
|
9
|
-
__all__ = [
|
13
|
+
__all__: list = [
|
14
|
+
"MatlabHandler",
|
15
|
+
"MatlabConfig",
|
16
|
+
"MatlabOptions",
|
17
|
+
"get_handler",
|
18
|
+
]
|
10
19
|
|
11
20
|
|
12
21
|
# Add custom sections to the numpy and google docstring parsers
|
@@ -26,3 +35,17 @@ extensions = {
|
|
26
35
|
|
27
36
|
google._section_kind.update(extensions)
|
28
37
|
numpy._section_kind.update(extensions)
|
38
|
+
|
39
|
+
|
40
|
+
# Filter griffe logger to remove return type warnings, as this is possible in MATLAB
|
41
|
+
class ReturnTypeWarningFilter(logging.Filter):
|
42
|
+
def filter(self, record):
|
43
|
+
if hasattr(record, "msg"):
|
44
|
+
message = str(record.msg)
|
45
|
+
if "No type or annotation for returned value" in message:
|
46
|
+
return False
|
47
|
+
return True
|
48
|
+
|
49
|
+
|
50
|
+
griffe_logger: logging.Logger = logging.getLogger("mkdocs.plugins.griffe")
|
51
|
+
griffe_logger.addFilter(ReturnTypeWarningFilter())
|