mkdocstrings-matlab 0.7.0__py3-none-any.whl → 0.8.1__py3-none-any.whl

mkdocstrings_handlers/matlab/collect.py

@@ -771,7 +771,7 @@ class LazyModel:
 
     def _collect_folder(self, path: Path) -> Folder:
         name = path.stem
-        model = Folder(name, filepath=path, path_collection=self._path_collection)
+        model = Folder("/" + name, filepath=path, path_collection=self._path_collection)
         return self._collect_directory(path, model)
 
     def _collect_readme_md(self, path, parent: PathMixin) -> Docstring | None:

mkdocstrings_handlers/matlab/handler.py

@@ -2,8 +2,9 @@
 
 from pathlib import Path
 from collections import ChainMap
+from jinja2.loaders import FileSystemLoader
 from markdown import Markdown
-from mkdocstrings.extension import PluginError
+from mkdocs.exceptions import PluginError
 from mkdocstrings.handlers.base import BaseHandler, CollectorItem, CollectionError
 from mkdocstrings_handlers.python import rendering
 from typing import Any, ClassVar, Mapping
@@ -152,7 +153,9 @@ class MatlabHandler(BaseHandler):
 
     def __init__(
         self,
-        *args: Any,
+        handler: str,
+        theme: str,
+        custom_templates: str | None = None,
         config_file_path: str | None = None,
         paths: list[str] | None = None,
         paths_recursive: bool = False,
@@ -163,7 +166,9 @@ class MatlabHandler(BaseHandler):
         Initialize the handler with the given configuration.
 
         Args:
-            *args (Any): Variable length argument list.
+            handler: The name of the handler.
+            theme: The name of theme to use.
+            custom_templates: Directory containing custom templates.
             config_file_path (str | None, optional): Path to the configuration file. Defaults to None.
             paths (list[str] | None, optional): List of paths to include. Defaults to None.
             paths_recursive (bool, optional): Whether to include paths recursively. Defaults to False.
@@ -173,7 +178,16 @@ class MatlabHandler(BaseHandler):
         Returns:
             None
         """
-        super().__init__(*args, **kwargs)
+
+        super().__init__(handler, theme, custom_templates=custom_templates)
+
+        theme_path = Path(__file__).resolve().parent / "templates" / theme
+        if theme_path.exists() and isinstance(self.env.loader, FileSystemLoader):
+            # Insert our templates directory at the beginning of the search path to overload the Python templates
+            self.env.loader.searchpath.insert(0, str(theme_path))
+        css_path = theme_path / "style.css"
+        if css_path.exists():
+            self.extra_css += "\n" + css_path.read_text(encoding="utf-8")
 
         if paths is None or config_file_path is None:
             config_path = None
@@ -182,13 +196,19 @@ class MatlabHandler(BaseHandler):
             config_path = Path(config_file_path).parent
             full_paths = [(config_path / path).resolve() for path in paths]
 
+        if pathIds := [str(path) for path in full_paths if not path.is_dir()]:
+            raise PluginError(
+                "The following paths do not exist or are not directories: "
+                + ", ".join(pathIds)
+            )
+
         self.paths: PathCollection = PathCollection(
             full_paths, recursive=paths_recursive, config_path=config_path
         )
         self.lines: LinesCollection = self.paths.lines_collection
         self._locale: str = locale
 
-    def get_templates_dir(self, handler: str | None = None) -> Path:
+    def get_templates_dir(self, *args, **kwargs) -> Path:
         # use the python handler templates
         # (it assumes the python handler is installed)
         return super().get_templates_dir("python")
@@ -254,7 +274,6 @@ class MatlabHandler(BaseHandler):
             }
 
         # Map docstring options
-        final_config["show_submodules"] = config.get("show_subnamespaces", False)
         final_config["show_docstring_attributes"] = config.get(
             "show_docstring_properties", True
         )
@@ -339,7 +358,10 @@ class MatlabHandler(BaseHandler):
             raise CollectionError("Empty identifier")
 
         final_config = ChainMap(config, self.default_config)  # type: ignore[arg-type]
-        return self.paths.resolve(identifier, config=final_config)
+        model = self.paths.resolve(identifier, config=final_config)
+        if model is None:
+            raise CollectionError(f"Identifier '{identifier}' not found")
+        return model
 
 
 def get_handler(

mkdocstrings_handlers/matlab/models.py

@@ -141,13 +141,24 @@ class MatlabObject(Object):
             path_collection (PathCollection | None): The collection of paths related to the object.
             **kwargs: Arbitrary keyword arguments.
         """
-
         self.path_collection: "PathCollection | None" = path_collection
         lines_collection = (
             path_collection.lines_collection if path_collection is not None else None
         )
         super().__init__(*args, lines_collection=lines_collection, **kwargs)
 
+    @property
+    def namespaces(self) -> dict[str, "Namespace"]:
+        return {}
+
+    @property
+    def is_namespace(self) -> bool:
+        return False
+
+    @property
+    def is_folder(self) -> bool:
+        return False
+
     @property
     def canonical_path(self) -> str:
         """
@@ -182,8 +193,8 @@ class PathMixin(Object):
     """
 
     def __init__(self, *args: Any, filepath: Path | None = None, **kwargs: Any) -> None:
-        self._filepath: Path | None = filepath
         super().__init__(*args, **kwargs)
+        self._filepath: Path | None = filepath
 
     @property
     def filepath(self) -> Path | None:
@@ -201,9 +212,9 @@ class MatlabMixin(Object):
         docstring: Docstring | None = None,
         **kwargs: Any,
     ):
+        super().__init__(*args, **kwargs)
         self._parent: "Class | Classfolder | Namespace | _ParentGrabber | None" = parent
         self._docstring: Docstring | None = docstring
-        super().__init__(*args, **kwargs)
 
     @property
     def parent(self) -> Object | None:
@@ -426,6 +437,8 @@ class Property(MatlabMixin, Attribute, MatlabObject):
         self.SetAccess: AccessEnum = SetAccess
         self.getter: Function | None = None
 
+        self.extra["mkdocstrings"] = {"template": "property.html.jinja"}
+
     @property
     def Private(self) -> bool:
         private = self.Access != AccessEnum.public
@@ -554,11 +567,23 @@ class Folder(MatlabMixin, PathMixin, Module, MatlabObject):
 
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
-        self.labels = {"Folder"}
+        self.extra["mkdocstrings"] = {"template": "folder.html.jinja"}
 
     def __repr__(self) -> str:
         return f"Folder({self.path!r})"
 
+    @property
+    def namespaces(self) -> dict[str, "Namespace"]:
+        return {
+            name: member
+            for name, member in self.members.items()
+            if isinstance(member, Namespace)
+        }
+
+    @property
+    def is_folder(self) -> bool:
+        return True
+
 
 class Namespace(MatlabMixin, PathMixin, Module, MatlabObject):
     """
@@ -574,6 +599,7 @@ class Namespace(MatlabMixin, PathMixin, Module, MatlabObject):
     def __init__(self, *args: Any, **kwargs: Any) -> None:
         super().__init__(*args, **kwargs)
         self._access: AccessEnum = AccessEnum.public
+        self.extra["mkdocstrings"] = {"template": "namespace.html.jinja"}
 
     def __repr__(self) -> str:
         return f"Namespace({self.path!r})"
@@ -585,3 +611,7 @@ class Namespace(MatlabMixin, PathMixin, Module, MatlabObject):
             if self.filepath
             else False
         )
+
+    @property
+    def is_namespace(self) -> bool:
+        return True

mkdocstrings_handlers/matlab/templates/material/children.html.jinja

@@ -0,0 +1,172 @@
+{#- Template for members (children) of an object.
+
+This template iterates on members of a given object and renders them.
+It can group members by category (attributes, classes, functions, modules) or render them in a flat list.
+
+Context:
+  obj (griffe.Object): The object to render.
+  config (dict): The configuration options.
+  root_members (bool): Whether the object is the root object.
+  heading_level (int): The HTML heading level to use.
+-#}
+
+{% if obj.all_members %}
+  {% block logs scoped %}
+    {#- Logging block.
+    
+    This block can be used to log debug messages, deprecation messages, warnings, etc.
+    -#}
+    {{ log.debug("Rendering children of " + obj.path) }}
+  {% endblock logs %}
+
+  <div class="doc doc-children">
+
+    {% if root_members %}
+      {% set members_list = config.members %}
+    {% else %}
+      {% set members_list = none %}
+    {% endif %}
+
+    {% if config.group_by_category %}
+
+      {% with %}
+
+        {% if config.show_category_heading %}
+          {% set extra_level = 1 %}
+        {% else %}
+          {% set extra_level = 0 %}
+        {% endif %}
+
+        {% with attributes = obj.attributes|filter_objects(
+            filters=config.filters,
+            members_list=members_list,
+            inherited_members=config.inherited_members,
+            keep_no_docstrings=config.show_if_no_docstring,
+          ) %}
+          {% if attributes %}
+            {% if config.show_category_heading %}
+              {% filter heading(heading_level, id=html_id ~ "-properties") %}Properties{% endfilter %}
+            {% endif %}
+            {% with heading_level = heading_level + extra_level %}
+              {% for attribute in attributes|order_members(config.members_order, members_list) %}
+                {% if members_list is not none or (not attribute.is_imported or attribute.is_public) %}
+                  {% include attribute|get_template with context %}
+                {% endif %}
+              {% endfor %}
+            {% endwith %}
+          {% endif %}
+        {% endwith %}
+
+        {% with classes = obj.classes|filter_objects(
+            filters=config.filters,
+            members_list=members_list,
+            inherited_members=config.inherited_members,
+            keep_no_docstrings=config.show_if_no_docstring,
+          ) %}
+          {% if classes %}
+            {% if config.show_category_heading %}
+              {% filter heading(heading_level, id=html_id ~ "-classes") %}Classes{% endfilter %}
+            {% endif %}
+            {% with heading_level = heading_level + extra_level %}
+              {% for class in classes|order_members(config.members_order, members_list) %}
+                {% if members_list is not none or (not class.is_imported or class.is_public) %}
+                  {% include class|get_template with context %}
+                {% endif %}
+              {% endfor %}
+            {% endwith %}
+          {% endif %}
+        {% endwith %}
+
+        {% with functions = obj.functions|filter_objects(
+            filters=config.filters,
+            members_list=members_list,
+            inherited_members=config.inherited_members,
+            keep_no_docstrings=config.show_if_no_docstring,
+          ) %}
+          {% if functions %}
+            {% if config.show_category_heading %}
+              {% filter heading(heading_level, id=html_id ~ "-functions") %}Functions{% endfilter %}
+            {% endif %}
+            {% with heading_level = heading_level + extra_level %}
+              {% for function in functions|order_members(config.members_order, members_list) %}
+                {% if not (obj.kind.value == "class" and function.name == "__init__" and config.merge_init_into_class) %}
+                  {% if members_list is not none or (not function.is_imported or function.is_public) %}
+                    {% include function|get_template with context %}
+                  {% endif %}
+                {% endif %}
+              {% endfor %}
+            {% endwith %}
+          {% endif %}
+        {% endwith %}
+
+        {% if config.show_subnamespaces or obj.is_folder %}
+          {% with modules = obj.modules|filter_objects(
+              filters=config.filters,
+              members_list=members_list,
+              inherited_members=config.inherited_members,
+              keep_no_docstrings=config.show_if_no_docstring,
+            ) %}
+            {% if modules %}
+              {% if config.show_category_heading %}
+                {% filter heading(heading_level, id=html_id ~ "-namespaces") %}Modules{% endfilter %}
+              {% endif %}
+              {% with heading_level = heading_level + extra_level %}
+                {% for module in modules|order_members(config.members_order.alphabetical, members_list) %}
+                  {% if members_list is not none or (not module.is_alias or module.is_public) %}
+                    {% include module|get_template with context %}
+                  {% endif %}
+                {% endfor %}
+              {% endwith %}
+            {% endif %}
+          {% endwith %}
+        {% endif %}
+
+      {% endwith %}
+
+    {% else %}
+
+      {% for child in obj.all_members
+          |filter_objects(
+            filters=config.filters,
+            members_list=members_list,
+            inherited_members=config.inherited_members,
+            keep_no_docstrings=config.show_if_no_docstring,
+            )
+          |order_members(config.members_order, members_list)
+        %}
+
+        {% if not (obj.is_class and child.name == "__init__" and config.merge_init_into_class) %}
+
+          {% if members_list is not none or child.is_public %}
+            {% if child.is_attribute %}
+              {% with attribute = child %}
+                {% include attribute|get_template with context %}
+              {% endwith %}
+
+            {% elif child.is_class %}
+              {% with class = child %}
+                {% include class|get_template with context %}
+              {% endwith %}
+
+            {% elif child.is_function %}
+              {% with function = child %}
+                {% include function|get_template with context %}
+              {% endwith %}
+
+            {% elif (child.is_namespace and config.show_subnamespaces) or obj.is_folder %}
+              {% with module = child %}
+                {% include module|get_template with context %}
+              {% endwith %}
+
+            {% endif %}
+          {% endif %}
+
+        {% endif %}
+
+      {% endfor %}
+
+    {% endif %}
+
+  </div>
+
+{% endif %}

mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja

@@ -0,0 +1,86 @@
+{#- Template for "Namespaces" sections in docstrings.
+
+This template renders a list of documented namespaces in the format
+specified with the [`docstring_section_style`][] configuration option.
+
+Context:
+  section (griffe.DocstringSectionAttributes): The section to render.
+-#}
+
+{% block logs scoped %}
+  {#- Logging block.
+  
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+  {{ log.debug("Rendering namespaces section") }}
+{% endblock logs %}
+
+{% import "language"|get_template as lang with context %}
+{#- Language module providing the `t` translation method. -#}
+
+{% if config.docstring_section_style == "table" %}
+  {% block table_style scoped %}
+    {#- Block for the `table` section style. -#}
+    <p><span class="doc-section-title">{{ section.title or "Namespaces:" }}</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>{{ lang.t("Name") }}</th>
+          <th>{{ lang.t("Description") }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for module in section.value %}
+          <tr class="doc-section-item">
+            <td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
+            <td>
+              <div class="doc-md-description">
+                {{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+            </td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  {% endblock table_style %}
+{% elif config.docstring_section_style == "list" %}
+  {% block list_style scoped %}
+    {#- Block for the `list` section style. -#}
+    <p><span class="doc-section-title">{{ section.title or "Namespaces:" }}</span></p>
+    <ul>
+      {% for module in section.value %}
+        <li class="doc-section-item field-body">
+          <b><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></b>
+          –
+          <div class="doc-md-description">
+            {{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+          </div>
+        </li>
+      {% endfor %}
+    </ul>
+  {% endblock list_style %}
+{% elif config.docstring_section_style == "spacy" %}
+  {% block spacy_style scoped %}
+    {#- Block for the `spacy` section style. -#}
+    <table>
+      <thead>
+        <tr>
+          <th><span class="doc-section-title">{{ (section.title or "NAMESPACE:").rstrip(":").upper() }}</span></th>
+          <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for module in section.value %}
+          <tr class="doc-section-item">
+            <td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
+            <td class="doc-module-details">
+              <div class="doc-md-description">
+                {{ module.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+            </td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  {% endblock spacy_style %}
+{% endif %}

mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja

@@ -0,0 +1,109 @@
+{#- Template for "Properties" sections in docstrings.
+
+This template renders a list of documented properties in the format
+specified with the [`docstring_section_style`][] configuration option.
+
+Context:
+  section (griffe.DocstringSectionAttributes): The section to render.
+-#}
+
+{% block logs scoped %}
+  {#- Logging block.
+  
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+  {{ log.debug("Rendering properties section") }}
+{% endblock logs %}
+
+{% import "language"|get_template as lang with context %}
+{#- Language module providing the `t` translation method. -#}
+
+{% if config.docstring_section_style == "table" %}
+  {% block table_style scoped %}
+    {#- Block for the `table` section style. -#}
+    <p><span class="doc-section-title">{{ section.title or "Properties:" }}</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>{{ lang.t("Name") }}</th>
+          <th>{{ lang.t("Type") }}</th>
+          <th>{{ lang.t("Description") }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for attribute in section.value %}
+          <tr class="doc-section-item">
+            <td><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></td>
+            <td>
+              {% if attribute.annotation %}
+                {% with expression = attribute.annotation %}
+                  <code>{% include "expression"|get_template with context %}</code>
+                {% endwith %}
+              {% endif %}
+            </td>
+            <td>
+              <div class="doc-md-description">
+                {{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+            </td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  {% endblock table_style %}
+{% elif config.docstring_section_style == "list" %}
+  {% block list_style scoped %}
+    {#- Block for the `list` section style. -#}
+    <p><span class="doc-section-title">{{ section.title or "Properties:" }}</span></p>
+    <ul>
+      {% for attribute in section.value %}
+        <li class="doc-section-item field-body">
+          <b><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></b>
+          {% if attribute.annotation %}
+            {% with expression = attribute.annotation %}
+              (<code>{% include "expression"|get_template with context %}</code>)
+            {% endwith %}
+          {% endif %}
+          –
+          <div class="doc-md-description">
+            {{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+          </div>
+        </li>
+      {% endfor %}
+    </ul>
+  {% endblock list_style %}
+{% elif config.docstring_section_style == "spacy" %}
+  {% block spacy_style scoped %}
+    {#- Block for the `spacy` section style. -#}
+    <table>
+      <thead>
+        <tr>
+          <th><span class="doc-section-title">{{ (section.title or "PROPERTY:").rstrip(":").upper() }}</span></th>
+          <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for attribute in section.value %}
+          <tr class="doc-section-item">
+            <td><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></td>
+            <td class="doc-attribute-details">
+              <div class="doc-md-description">
+                {{ attribute.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+              <p>
+                {% if attribute.annotation %}
+                  <span class="doc-attribute-annotation">
+                    <b>TYPE:</b>
+                    {% with expression = attribute.annotation %}
+                      <code>{% include "expression"|get_template with context %}</code>
+                    {% endwith %}
+                  </span>
+                {% endif %}
+              </p>
+            </td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  {% endblock spacy_style %}
+{% endif %}

mkdocstrings_handlers/matlab/templates/material/folder.html.jinja

@@ -0,0 +1,121 @@
+{#- Template for Python modules.
+
+This template renders a Python module.
+
+Context:
+  module (griffe.Module): The module to render.
+  root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
+  heading_level (int): The HTML heading level to use.
+  config (dict): The configuration options.
+-#}
+
+{% block logs scoped %}
+  {#- Logging block.
+  
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+  {{ log.debug("Rendering " + module.path) }}
+{% endblock logs %}
+
+<div class="doc doc-object doc-module">
+  {% with obj = module, html_id = module.path %}
+
+    {% if root %}
+      {% set show_full_path = config.show_root_full_path %}
+      {% set root_members = True %}
+    {% elif root_members %}
+      {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+      {% set root_members = False %}
+    {% else %}
+      {% set show_full_path = config.show_object_full_path %}
+    {% endif %}
+
+    {% set module_name = module.path if show_full_path else module.name %}
+
+    {% if not root or config.show_root_heading %}
+      {% filter heading(
+          heading_level,
+          role="module",
+          id=html_id,
+          class="doc doc-heading",
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-folder"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + module.name,
+        ) %}
+
+        {% block heading scoped %}
+          {#- Heading block.
+          
+          This block renders the heading for the module.
+          -#}
+          {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-folder"></code>{% endif %}
+          {% if config.separate_signature %}
+            <span class="doc doc-object-name doc-module-name">{{ module_name }}</span>
+          {% else %}
+            <code>{{ module_name }}</code>
+          {% endif %}
+        {% endblock heading %}
+
+        {% block labels scoped %}
+          {#- Labels block.
+          
+          This block renders the labels for the module.
+          -#}
+          {% with labels = module.labels %}
+            {% include "labels"|get_template with context %}
+          {% endwith %}
+        {% endblock labels %}
+
+      {% endfilter %}
+
+    {% else %}
+      {% if config.show_root_toc_entry %}
+        {% filter heading(heading_level,
+            role="module",
+            id=html_id,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-folder"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + module.name,
+            hidden=True,
+          ) %}
+        {% endfilter %}
+      {% endif %}
+      {% set heading_level = heading_level - 1 %}
+    {% endif %}
+
+    <div class="doc doc-contents {% if root %}first{% endif %}">
+      {% block contents scoped %}
+        {#- Contents block.
+        
+        This block renders the contents of the module.
+        It contains other blocks that users can override.
+        Overriding the contents block allows to rearrange the order of the blocks.
+        -#}
+        {% block docstring scoped %}
+          {#- Docstring block.
+          
+          This block renders the docstring for the module.
+          -#}
+          {% with docstring_sections = module.docstring.parsed %}
+            {% include "docstring"|get_template with context %}
+          {% endwith %}
+        {% endblock docstring %}
+
+        {% block summary scoped %}
+          {#- Summary block.
+          
+          This block renders auto-summaries for classes, methods, and attributes.
+          -#}
+          {% include "summary"|get_template with context %}
+        {% endblock summary %}
+
+        {% block children scoped %}
+          {#- Children block.
+          
+          This block renders the children (members) of the module.
+          -#}
+          {% set root = False %}
+          {% set heading_level = heading_level + 1 %}
+          {% include "children"|get_template with context %}
+        {% endblock children %}
+      {% endblock contents %}
+    </div>
+
+  {% endwith %}
+</div>

mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja

@@ -0,0 +1,121 @@
+{#- Template for Python modules.
+
+This template renders a Python module.
+
+Context:
+  module (griffe.Module): The module to render.
+  root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
+  heading_level (int): The HTML heading level to use.
+  config (dict): The configuration options.
+-#}
+
+{% block logs scoped %}
+  {#- Logging block.
+  
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+  {{ log.debug("Rendering " + module.path) }}
+{% endblock logs %}
+
+<div class="doc doc-object doc-module">
+  {% with obj = module, html_id = module.path %}
+
+    {% if root %}
+      {% set show_full_path = config.show_root_full_path %}
+      {% set root_members = True %}
+    {% elif root_members %}
+      {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+      {% set root_members = False %}
+    {% else %}
+      {% set show_full_path = config.show_object_full_path %}
+    {% endif %}
+
+    {% set module_name = module.path + ".*" if show_full_path else module.name + ".*" %}
+
+    {% if not root or config.show_root_heading %}
+      {% filter heading(
+          heading_level,
+          role="module",
+          id=html_id,
+          class="doc doc-heading",
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-namespace"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + module.name,
+        ) %}
+
+        {% block heading scoped %}
+          {#- Heading block.
+          
+          This block renders the heading for the module.
+          -#}
+          {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-namespace"></code>{% endif %}
+          {% if config.separate_signature %}
+            <span class="doc doc-object-name doc-module-name">{{ module_name }}</span>
+          {% else %}
+            <code>{{ module_name }}</code>
+          {% endif %}
+        {% endblock heading %}
+
+        {% block labels scoped %}
+          {#- Labels block.
+          
+          This block renders the labels for the module.
+          -#}
+          {% with labels = module.labels %}
+            {% include "labels"|get_template with context %}
+          {% endwith %}
+        {% endblock labels %}
+
+      {% endfilter %}
+
+    {% else %}
+      {% if config.show_root_toc_entry %}
+        {% filter heading(heading_level,
+            role="module",
+            id=html_id,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-namespace"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + module.name,
+            hidden=True,
+          ) %}
+        {% endfilter %}
+      {% endif %}
+      {% set heading_level = heading_level - 1 %}
+    {% endif %}
+
+    <div class="doc doc-contents {% if root %}first{% endif %}">
+      {% block contents scoped %}
+        {#- Contents block.
+        
+        This block renders the contents of the module.
+        It contains other blocks that users can override.
+        Overriding the contents block allows to rearrange the order of the blocks.
+        -#}
+        {% block docstring scoped %}
+          {#- Docstring block.
+          
+          This block renders the docstring for the module.
+          -#}
+          {% with docstring_sections = module.docstring.parsed %}
+            {% include "docstring"|get_template with context %}
+          {% endwith %}
+        {% endblock docstring %}
+
+        {% block summary scoped %}
+          {#- Summary block.
+          
+          This block renders auto-summaries for classes, methods, and attributes.
+          -#}
+          {% include "summary"|get_template with context %}
+        {% endblock summary %}
+
+        {% block children scoped %}
+          {#- Children block.
+          
+          This block renders the children (members) of the module.
+          -#}
+          {% set root = False %}
+          {% set heading_level = heading_level + 1 %}
+          {% include "children"|get_template with context %}
+        {% endblock children %}
+      {% endblock contents %}
+    </div>
+
+  {% endwith %}
+</div>

mkdocstrings_handlers/matlab/templates/material/property.html.jinja

@@ -0,0 +1,120 @@
+{#- Template for Python attributes.
+
+This template renders a Python attribute (or variable).
+This can be a module attribute or a class attribute.
+
+Context:
+  attribute (griffe.Attribute): The attribute to render.
+  root (bool): Whether this is the root object, injected with `:::` in a Markdown page.
+  heading_level (int): The HTML heading level to use.
+  config (dict): The configuration options.
+-#}
+
+{% block logs scoped %}
+  {#- Logging block.
+  
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+  {{ log.debug("Rendering " + attribute.path) }}
+{% endblock logs %}
+
+<div class="doc doc-object doc-attribute">
+  {% with obj = attribute, html_id = attribute.path %}
+
+    {% if root %}
+      {% set show_full_path = config.show_root_full_path %}
+      {% set root_members = True %}
+    {% elif root_members %}
+      {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+      {% set root_members = False %}
+    {% else %}
+      {% set show_full_path = config.show_object_full_path %}
+    {% endif %}
+
+    {% set attribute_name = attribute.path if show_full_path else attribute.name %}
+
+    {% if not root or config.show_root_heading %}
+      {% filter heading(
+          heading_level,
+          role="data" if attribute.parent.kind.value == "module" else "attr",
+          id=html_id,
+          class="doc doc-heading",
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-property"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + attribute.name,
+        ) %}
+
+        {% block heading scoped %}
+          {#- Heading block.
+          
+          This block renders the heading for the attribute.
+          -#}
+          {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-property"></code>{% endif %}
+          {% if config.separate_signature %}
+            <span class="doc doc-object-name doc-attribute-name">{{ attribute_name }}</span>
+          {% else %}
+            {%+ filter highlight(language="python", inline=True) %}
+              {{ attribute_name }}{% if attribute.annotation and config.show_signature_annotations %}: {{ attribute.annotation }}{% endif %}
+              {% if attribute.value %} = {{ attribute.value }}{% endif %}
+            {% endfilter %}
+          {% endif %}
+        {% endblock heading %}
+
+        {% block labels scoped %}
+          {#- Labels block.
+          
+          This block renders the labels for the attribute.
+          -#}
+          {% with labels = attribute.labels %}
+            {% include "labels"|get_template with context %}
+          {% endwith %}
+        {% endblock labels %}
+
+      {% endfilter %}
+
+      {% block signature scoped %}
+        {#- Signature block.
+        
+        This block renders the signature for the attribute.
+        -#}
+        {% if config.separate_signature %}
+          {% filter format_attribute(attribute, config.line_length, crossrefs=config.signature_crossrefs) %}
+            {{ attribute.name }}
+          {% endfilter %}
+        {% endif %}
+      {% endblock signature %}
+
+    {% else %}
+
+      {% if config.show_root_toc_entry %}
+        {% filter heading(heading_level,
+            role="data" if attribute.parent.kind.value == "module" else "attr",
+            id=html_id,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-property"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + attribute.name,
+            hidden=True,
+          ) %}
+        {% endfilter %}
+      {% endif %}
+      {% set heading_level = heading_level - 1 %}
+    {% endif %}
+
+    <div class="doc doc-contents {% if root %}first{% endif %}">
+      {% block contents scoped %}
+        {#- Contents block.
+        
+        This block renders the contents of the attribute.
+        It contains other blocks that users can override.
+        Overriding the contents block allows to rearrange the order of the blocks.
+        -#}
+        {% block docstring scoped %}
+          {#- Docstring block.
+          
+          This block renders the docstring for the attribute.
+          -#}
+          {% with docstring_sections = attribute.docstring.parsed %}
+            {% include "docstring"|get_template with context %}
+          {% endwith %}
+        {% endblock docstring %}
+      {% endblock contents %}
+    </div>
+
+  {% endwith %}
+</div>

mkdocstrings_handlers/matlab/templates/material/style.css

@@ -0,0 +1,26 @@
+code.doc-symbol-namespace {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
+}
+
+code.doc-symbol-namespace::after {
+  content: "name";
+}
+
+code.doc-symbol-folder {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
+}
+
+code.doc-symbol-folder::after {
+  content: "dir";
+}
+
+code.doc-symbol-property {
+  color: var(--doc-symbol-attribute-fg-color);
+  background-color: var(--doc-symbol-attribute-bg-color);
+}
+
+code.doc-symbol-property::after {
+  content: "prop";
+}

mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja

@@ -0,0 +1,21 @@
+{#- Summary of namespaces. -#}
+
+{% block logs scoped %}
+  {#- Logging block.
+  
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+{% endblock logs %}
+
+{% with section = obj.modules
+    |filter_objects(
+      filters=config.filters,
+      members_list=members_list,
+      inherited_members=config.inherited_members,
+      keep_no_docstrings=config.show_if_no_docstring,
+    )
+    |order_members(config.members_order.alphabetical, members_list)
+    |as_modules_section(check_public=not members_list)
+  %}
+  {% if section %}{% include "docstring/namespaces"|get_template with context %}{% endif %}
+{% endwith %}

mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja

@@ -0,0 +1,21 @@
+{#- Summary of properties. -#}
+
+{% block logs scoped %}
+  {#- Logging block.
+  
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+{% endblock logs %}
+
+{% with section = obj.attributes
+    |filter_objects(
+      filters=config.filters,
+      members_list=members_list,
+      inherited_members=config.inherited_members,
+      keep_no_docstrings=config.show_if_no_docstring,
+    )
+    |order_members(config.members_order, members_list)
+    |as_attributes_section(check_public=not members_list)
+  %}
+  {% if section %}{% include "docstring/properties"|get_template with context %}{% endif %}
+{% endwith %}

mkdocstrings_handlers/matlab/templates/material/summary.html.jinja

@@ -0,0 +1,26 @@
+{#- Template for auto-summaries. -#}
+
+{% block logs scoped %}
+  {#- Logging block.
+  
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+{% endblock logs %}
+
+{% with members_list = config.members if root_members else None %}
+  {% if config.summary.modules %}
+    {% include "summary/namespaces"|get_template with context %}
+  {% endif %}
+
+  {% if config.summary.classes %}
+    {% include "summary/classes"|get_template with context %}
+  {% endif %}
+
+  {% if config.summary.functions %}
+    {% include "summary/functions"|get_template with context %}
+  {% endif %}
+
+  {% if config.summary.attributes %}
+    {% include "summary/properties"|get_template with context %}
+  {% endif %}
+{% endwith %}

{mkdocstrings_matlab-0.7.0.dist-info → mkdocstrings_matlab-0.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: mkdocstrings-matlab
-Version: 0.7.0
+Version: 0.8.1
 Summary: A MATLAB handler for mkdocstrings
 Author-email: Mark Hu <watermarkhu@gmail.com>
 License: MIT
@@ -21,11 +21,11 @@ Classifier: Topic :: Software Development :: Documentation
 Classifier: Topic :: Utilities
 Classifier: Typing :: Typed
 Requires-Python: >=3.10
-Requires-Dist: charset-normalizer>=3.3.2
+Requires-Dist: charset-normalizer==3.4.1
 Requires-Dist: mkdocstrings-python==1.13.0
 Requires-Dist: mkdocstrings==0.27.0
-Requires-Dist: tree-sitter-matlab>=1.0.2
-Requires-Dist: tree-sitter>=0.23.2
+Requires-Dist: tree-sitter-matlab==1.0.3
+Requires-Dist: tree-sitter==0.23.2
 Description-Content-Type: text/markdown
 
 <!-- --8<-- [start:header] -->

mkdocstrings_matlab-0.8.1.dist-info/RECORD

@@ -0,0 +1,21 @@
+mkdocstrings_handlers/matlab/__init__.py,sha256=w5R9cGtqeJF0GUP_Jc_ad8FnS4FpbutnmHvzVRlohPM,1124
+mkdocstrings_handlers/matlab/collect.py,sha256=lmV2fgkRhxWrpNrFes19kY3hDEa_-B01DryHTP9XALU,29755
+mkdocstrings_handlers/matlab/enums.py,sha256=lr3wLlhPxyBym3O7Rt0cLUZYqPCz6wQ2PYBibLKLTek,982
+mkdocstrings_handlers/matlab/handler.py,sha256=kHyBrHTvZJBXVgondNcbjyeRna0pMmfCnIDVk7ru3oQ,19708
+mkdocstrings_handlers/matlab/models.py,sha256=MqLZNL3um0yEeFSzv-xjzwjFpOyCdx7elyZ4X1ZV-yE,19228
+mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+mkdocstrings_handlers/matlab/treesitter.py,sha256=FkWGuH7EmE_aO2qub5-_NnOVacYeXW353SkB7cNMlRo,21820
+mkdocstrings_handlers/matlab/templates/material/children.html.jinja,sha256=61OLBlQw3SaRscBkN7hVpbuSX2Bo7I0j_F581eDAUn8,6462
+mkdocstrings_handlers/matlab/templates/material/folder.html.jinja,sha256=cWgaQH4EDFgL3eEIv0NRwRXYvtn9pp4tW7ntv3X2nM8,4076
+mkdocstrings_handlers/matlab/templates/material/namespace.html.jinja,sha256=a7Ya3YuN3hNEvqb_aG5Yr3QCuFYv6UhX5B26Gx2-tUQ,4099
+mkdocstrings_handlers/matlab/templates/material/property.html.jinja,sha256=anYCQM6AcyGgEApDC97TqzWlgVNtc1I_Ys1xyvUXye0,4396
+mkdocstrings_handlers/matlab/templates/material/style.css,sha256=0_Bs5_0fHM3X9l-IU1VHbZfhNA7nUw4SKEH_3zRhCDw,557
+mkdocstrings_handlers/matlab/templates/material/summary.html.jinja,sha256=hVbQGxbMWd6fl01afbg0LhfYCJD1IRPmmCdcDBxU650,735
+mkdocstrings_handlers/matlab/templates/material/docstring/namespaces.html.jinja,sha256=jLtPxNNfZFO3-Ozy0eHqxHvKmlPCODML_5xt8SJr8UE,3165
+mkdocstrings_handlers/matlab/templates/material/docstring/properties.html.jinja,sha256=9ckdYymLlB5sflwYEaEPAQLJuVWF8nezMCV5JnanXVA,4165
+mkdocstrings_handlers/matlab/templates/material/summary/namespaces.html.jinja,sha256=0vVlUB6oh-A7cpXbuDLOQLxTubyb_DisdOKm062WNMs,650
+mkdocstrings_handlers/matlab/templates/material/summary/properties.html.jinja,sha256=nyPaELf9qPCxJQFxK1MWYK4fPwsk5VESh9xKHLtd-XE,643
+mkdocstrings_matlab-0.8.1.dist-info/METADATA,sha256=iBefxEPWeQwl4OsJtxvjQGSTWUfAGgkhFIqSMm6shVM,4736
+mkdocstrings_matlab-0.8.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+mkdocstrings_matlab-0.8.1.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
+mkdocstrings_matlab-0.8.1.dist-info/RECORD,,

mkdocs_material_matlab/__init__.py

@@ -1,4 +0,0 @@
-from .mkdocs_material_matlab import MkdocsMaterialMatlabPlugin
-
-
-__all__ = ["MkdocsMaterialMatlabPlugin"]

mkdocs_material_matlab/css/style.css

@@ -1,7 +0,0 @@
-code.doc-symbol-attribute::after {
-  content: "prop" !important;
-}
-
-code.doc-symbol-module::after {
-  content: "name" !important;
-}

mkdocs_material_matlab/mkdocs_material_matlab.py

@@ -1,20 +0,0 @@
-from mkdocs.plugins import BasePlugin
-import os
-
-
-class MkdocsMaterialMatlabPlugin(BasePlugin):
-    def on_config(self, config):
-        # Ensure the custom CSS file is included in the extra_css list
-        css_path = "css/style.css"
-        if css_path not in config["extra_css"]:
-            config["extra_css"].append(css_path)
-        return config
-
-    def on_post_build(self, *, config):
-        # Ensure the custom CSS file is copied to the output directory
-        css_src_path = os.path.join(os.path.dirname(__file__), "css", "style.css")
-        css_dest_path = os.path.join(config["site_dir"], "css", "style.css")
-        os.makedirs(os.path.dirname(css_dest_path), exist_ok=True)
-        with open(css_src_path, "rb") as src_file:
-            with open(css_dest_path, "wb") as dest_file:
-                dest_file.write(src_file.read())

mkdocstrings_matlab-0.7.0.dist-info/RECORD

@@ -1,15 +0,0 @@
-mkdocs_material_matlab/__init__.py,sha256=9pmrwWbkIyr0T7qvADbsz3OR5bB3rWb231e6JSnwA7o,106
-mkdocs_material_matlab/mkdocs_material_matlab.py,sha256=s7vI1lv6hD8s7kDHWBfYKgN6EcldyUstGYJ45sA-VWY,850
-mkdocs_material_matlab/css/style.css,sha256=iVTPIKljgvK899jEQylD7yu9yjKfrVE_4GLaITjhk4g,132
-mkdocstrings_handlers/matlab/__init__.py,sha256=w5R9cGtqeJF0GUP_Jc_ad8FnS4FpbutnmHvzVRlohPM,1124
-mkdocstrings_handlers/matlab/collect.py,sha256=WXuRIDYL0T1fKv1MwwOC6uWAB80PxRCs4uYDgOHiQcg,29749
-mkdocstrings_handlers/matlab/enums.py,sha256=lr3wLlhPxyBym3O7Rt0cLUZYqPCz6wQ2PYBibLKLTek,982
-mkdocstrings_handlers/matlab/handler.py,sha256=-KA6kj8L55T9jxgKzNM_k59AXsyTSQJqFd8ltN00LQI,18710
-mkdocstrings_handlers/matlab/models.py,sha256=0qGk6UrGHB4fC49I2cjCgqLFAIozqtmLAxl9PPN6Blc,18461
-mkdocstrings_handlers/matlab/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/matlab/treesitter.py,sha256=FkWGuH7EmE_aO2qub5-_NnOVacYeXW353SkB7cNMlRo,21820
-mkdocstrings_matlab-0.7.0.dist-info/METADATA,sha256=5jzSXQm4dSLd9GBaJWSAvJm1JGBcuAGUaLWLpMoiGu0,4736
-mkdocstrings_matlab-0.7.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-mkdocstrings_matlab-0.7.0.dist-info/entry_points.txt,sha256=qUZFuB2TKh7KPlg4dR2npfbNgNExw6O6j1vF276PtPw,92
-mkdocstrings_matlab-0.7.0.dist-info/licenses/LICENSE,sha256=TZQpwBuA3KLH56--XDAY2Qwo9gGdxeTITYhMOylmYhg,743
-mkdocstrings_matlab-0.7.0.dist-info/RECORD,,

mkdocstrings_matlab-0.7.0.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[mkdocs.plugins]
-mkdocs-material-matlab = mkdocs_material_matlab:MkdocsMaterialMatlabPlugin