mkdocstrings-matlab 1.0.6__py3-none-any.whl → 1.0.8__py3-none-any.whl

mkdocstrings_handlers/matlab/config.py

@@ -358,10 +358,10 @@ class MatlabInputOptions:
     ] = "table"
 
     docstring_style: Annotated[
-        Literal["auto", "google", "numpy", "sphinx"] | None,
+        Literal["google", "numpy", "sphinx"] | None,
         Field(
             group="docstrings",
-            description="The docstring style to use: `auto`, `google`, `numpy`, `sphinx`, or `None`.",
+            description="The docstring style to use: `google`, `numpy`, `sphinx`, or `None`.",
         ),
     ] = "google"
 

mkdocstrings_handlers/matlab/handler.py

@@ -132,6 +132,9 @@ class MatlabHandler(BaseHandler):
         template_name = rendering.do_get_template(data)
         template = self.env.get_template(template_name)
 
+        if hasattr(data, "docstring") and data.docstring is not None:
+            data.docstring.parse()
+
         heading_level = options.heading_level
 
         html = template.render(

{mkdocstrings_matlab-1.0.6.dist-info → mkdocstrings_matlab-1.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 1.0.6
+Version: 1.0.8
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -21,8 +21,8 @@ Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: <3.14,>=3.10
 Requires-Dist: charset-normalizer~=3.4
-Requires-Dist: griffe~=1.13.0
-Requires-Dist: maxx~=0.3.0
+Requires-Dist: griffe~=1.14.0
+Requires-Dist: maxx~=0.4.2
 Requires-Dist: mkdocs-autorefs~=1.4
 Requires-Dist: mkdocstrings~=0.29
 Requires-Dist: typing-extensions>=4.0; python_version < '3.11'

{mkdocstrings_matlab-1.0.6.dist-info → mkdocstrings_matlab-1.0.8.dist-info}/RECORD

@@ -1,7 +1,6 @@
 mkdocstrings_handlers/matlab/__init__.py,sha256=zLE8MANvIbg-pEVFc9bGhhIUvqAjnSANBGqek-dm3LM,1721
-mkdocstrings_handlers/matlab/config.py,sha256=yuoB62JOm4vW5uJYd9mqvwIhtfmgSD34CMccc-9aEEc,26724
-mkdocstrings_handlers/matlab/handler.py,sha256=gD0ogRqzOlZAn_iv1E0xFflFj_tUmQcWUeWLPlp1RxI,9803
-mkdocstrings_handlers/matlab/logger.py,sha256=96hRpwOVyvEF0e9f8rvXnNBSBAuHEvM5a6bJNN8hjRo,3298
+mkdocstrings_handlers/matlab/config.py,sha256=LEv-tDlJrpKDz_g5cNKieCp3vlY1ZWTbWj2Y8RY0m8g,26708
+mkdocstrings_handlers/matlab/handler.py,sha256=ejp0w6ZplsdivdwbtiuTpt4nl58v0-ivn-bmH2UBDFc,9909
 mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/matlab/rendering.py,sha256=yhxpyAcEkCCC6of84ENip5QhEheVNl16E5jNjB53iZs,25726
 mkdocstrings_handlers/matlab/templates/material/attributes.html.jinja,sha256=3Wv9tRkBASmxW3NGdAw9V8mc7G6hc1pDIKmVQztlFJk,818
@@ -35,7 +34,7 @@ mkdocstrings_handlers/matlab/templates/material/summary/classes.html.jinja,sha25
 mkdocstrings_handlers/matlab/templates/material/summary/functions.html.jinja,sha256=f19-RvEkHZO4VegiQApq71nAEA27RKwQW3S2NMmKrW4,860
 mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja,sha256=J0aPYlktc5RY3Gax6GCZDxT5qgFDB5b3eqZZXfZOHxU,845
 mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja,sha256=0wQeDtZzfLSZPHJzLG_MVzre1NSyoSHowTwYzk0JX1c,857
-mkdocstrings_matlab-1.0.6.dist-info/METADATA,sha256=-pjAkLo_oWBuC8lX_JaRiHnm4I_GeyNMvYs0EV13oV8,4616
-mkdocstrings_matlab-1.0.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_matlab-1.0.6.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
-mkdocstrings_matlab-1.0.6.dist-info/RECORD,,
+mkdocstrings_matlab-1.0.8.dist-info/METADATA,sha256=20c9N9u40rHEqCtm7j-qNsk0yr2XdERHLhJBOnQ4xgo,4616
+mkdocstrings_matlab-1.0.8.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_matlab-1.0.8.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
+mkdocstrings_matlab-1.0.8.dist-info/RECORD,,

mkdocstrings_handlers/matlab/logger.py

@@ -1,111 +0,0 @@
-# This module contains the logger used throughout Griffe.
-# The logger is actually a wrapper around the standard Python logger.
-# We wrap it so that it is easier for other downstream libraries to patch it.
-# For example, mkdocstrings-python patches the logger to relocate it as a child
-# of `mkdocs.plugins` so that it fits in the MkDocs logging configuration.
-#
-# We use a single, global logger because our public API is exposed in a single module, `griffe`.
-# Extensions however should use their own logger, which is why we provide the `get_logger` function.
-
-from __future__ import annotations
-
-import logging
-from contextlib import contextmanager
-from typing import TYPE_CHECKING, Any, Callable, ClassVar
-
-if TYPE_CHECKING:
-    from collections.abc import Iterator
-
-
-class Logger:
-    _default_logger: Any = logging.getLogger
-    _instances: ClassVar[dict[str, Logger]] = {}
-
-    def __init__(self, name: str) -> None:
-        # Default logger that can be patched by third-party.
-        self._logger = self.__class__._default_logger(name)
-
-    def __getattr__(self, name: str) -> Any:
-        # Forward everything to the logger.
-        return getattr(self._logger, name)
-
-    @contextmanager
-    def disable(self) -> Iterator[None]:
-        """Temporarily disable logging."""
-        old_level = self._logger.level
-        self._logger.setLevel(100)
-        try:
-            yield
-        finally:
-            self._logger.setLevel(old_level)
-
-    @classmethod
-    def _get(cls, name: str = "griffe") -> Logger:
-        if name not in cls._instances:
-            cls._instances[name] = cls(name)
-        return cls._instances[name]
-
-    @classmethod
-    def _patch_loggers(cls, get_logger_func: Callable) -> None:
-        # Patch current instances.
-        for name, instance in cls._instances.items():
-            instance._logger = get_logger_func(name)
-
-        # Future instances will be patched as well.
-        cls._default_logger = get_logger_func
-
-
-logger: Logger = Logger._get()
-"""Our global logger, used throughout the library.
-
-Griffe's output and error messages are logging messages.
-
-Griffe provides the [`patch_loggers`][griffe.patch_loggers]
-function so dependent libraries can patch Griffe loggers as they see fit.
-
-For example, to fit in the MkDocs logging configuration
-and prefix each log message with the module name:
-
-```python
-import logging
-from griffe import patch_loggers
-
-
-class LoggerAdapter(logging.LoggerAdapter):
-    def __init__(self, prefix, logger):
-        super().__init__(logger, {})
-        self.prefix = prefix
-
-    def process(self, msg, kwargs):
-        return f"{self.prefix}: {msg}", kwargs
-
-
-def get_logger(name):
-    logger = logging.getLogger(f"mkdocs.plugins.{name}")
-    return LoggerAdapter(name, logger)
-
-
-patch_loggers(get_logger)
-```
-"""
-
-
-def get_logger(name: str = "griffe") -> Logger:
-    """Create and return a new logger instance.
-
-    Parameters:
-        name: The logger name.
-
-    Returns:
-        The logger.
-    """
-    return Logger._get(name)
-
-
-def patch_loggers(get_logger_func: Callable[[str], Any]) -> None:
-    """Patch Griffe logger and Griffe extensions' loggers.
-
-    Parameters:
-        get_logger_func: A function accepting a name as parameter and returning a logger.
-    """
-    Logger._patch_loggers(get_logger_func)