mkdocstrings-matlab 0.9.7__py3-none-any.whl → 1.0.0__py3-none-any.whl

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

@@ -0,0 +1,25 @@
+{#- Template for object attributes.
+
+mathworks.com/help/matlab/matlab_oop/class-attributes.html
+mathworks.com/help/matlab/matlab_oop/method-attributes.html
+mathworks.com/help/matlab/matlab_oop/property-attributes.html
+
+Context:
+    attributes (list): The list of attributes to render.
+    config (dict): The configuration options.
+-#}
+
+{% if config.show_attributes and attributes %}
+  {% block logs scoped %}
+    {#- Logging block.
+
+    This block can be used to log debug messages, deprecation messages, warnings, etc.
+    -#}
+    {{ log.debug("Rendering attributes") }}
+  {% endblock logs %}
+  <span class="doc doc-attributes">
+    {% for attribute in attributes|sort %}
+      <small class="doc doc-attribute doc-attribute-{{ attribute }}"><code>{{ attribute }}</code></small>
+    {% endfor %}
+  </span>
+{% endif %}

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

@@ -0,0 +1,17 @@
+{#- Template for backlinks.
+
+This template renders backlinks.
+
+Context:
+  backlinks (Mapping[str, Iterable[str]]): The backlinks to render.
+  config (dict): The configuration options.
+  verbose_type (Mapping[str, str]): The verbose backlink types.
+  default_crumb (BacklinkCrumb): A default, empty crumb.
+-#}
+
+{% block logs scoped %}
+  {#- Logging block.
+
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+{% endblock logs %}

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

@@ -1,10 +1,10 @@
 {#- 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.
+It can group members by category (properties, classes, functions, scripts, namespaces) or render them in a flat list.
 
 Context:
-  obj (griffe.Object): The object to render.
+  obj (mkdocstring_handlers.matlab.models.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.
@@ -13,7 +13,7 @@ Context:
 {% 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) }}
@@ -37,21 +37,21 @@ Context:
           {% set extra_level = 0 %}
         {% endif %}
 
-        {% with attributes = obj.attributes|filter_objects(
+        {% with properties = obj.properties|filter_objects(
             filters=config.filters,
             members_list=members_list,
             inherited_members=config.inherited_members,
+            private_members=config.private_members,
+            hidden_members=config.hidden_members,
             keep_no_docstrings=config.show_if_no_docstring,
           ) %}
-          {% if attributes %}
+          {% if properties %}
             {% 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 %}
+              {% for property in properties|order_members(config.members_order, members_list) %}
+                {% include property|get_template %}
               {% endfor %}
             {% endwith %}
           {% endif %}
@@ -61,6 +61,8 @@ Context:
             filters=config.filters,
             members_list=members_list,
             inherited_members=config.inherited_members,
+            private_members=config.private_members,
+            hidden_members=config.hidden_members,
             keep_no_docstrings=config.show_if_no_docstring,
           ) %}
           {% if classes %}
@@ -69,9 +71,7 @@ Context:
             {% 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 %}
+                {% include class|get_template %}
               {% endfor %}
             {% endwith %}
           {% endif %}
@@ -81,61 +81,64 @@ Context:
             filters=config.filters,
             members_list=members_list,
             inherited_members=config.inherited_members,
+            private_members=config.private_members,
+            hidden_members=config.hidden_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 %}
+              {% if obj.is_class %}
+                {% filter heading(heading_level, id=html_id ~ "-methods") %}Methods{% endfilter %}
+              {% else %}
+                {% filter heading(heading_level, id=html_id ~ "-functions") %}Functions{% endfilter %}
+              {% endif %}
             {% 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 %}
+                {% if not (obj.kind.value == "class" and function.name == obj.name and config.merge_constructor_into_class) %}
+                  {% include function|get_template %}
                 {% endif %}
               {% endfor %}
             {% endwith %}
           {% endif %}
         {% endwith %}
 
-        {% if obj.is_module %}
-          {% with scripts = obj.scripts|filter_objects(
-              filters=config.filters,
-              members_list=members_list,
-              keep_no_docstrings=config.show_if_no_docstring,
-            ) %}
-            {% if scripts %}
-              {% if config.show_category_heading %}
-                {% filter heading(heading_level, id=html_id ~ "-scripts") %}Scripts{% endfilter %}
-              {% endif %}
-              {% with heading_level = heading_level + extra_level %}
-                {% for script in scripts|order_members(config.members_order.alphabetical, members_list) %}
-                  {% if members_list is not none or (not script.is_alias or script.is_public) %}
-                    {% include script|get_template with context %}
-                  {% endif %}
-                {% endfor %}
-              {% endwith %}
+        {% with scripts = obj.scripts|filter_objects(
+            filters=config.filters,
+            members_list=members_list,
+            inherited_members=config.inherited_members,
+            private_members=config.private_members,
+            hidden_members=config.hidden_members,
+            keep_no_docstrings=config.show_if_no_docstring,
+          ) %}
+          {% if scripts %}
+            {% if config.show_category_heading %}
+              {% filter heading(heading_level, id=html_id ~ "-scripts") %}Scripts{% endfilter %}
             {% endif %}
-          {% endwith %}
-        {% endif %}
+            {% with heading_level = heading_level + extra_level %}
+              {% for script in scripts|order_members(config.members_order.alphabetical, members_list) %}
+                {% include script|get_template %}
+              {% endfor %}
+            {% endwith %}
+          {% endif %}
+        {% endwith %}
 
         {% if config.show_subnamespaces or obj.is_folder %}
-          {% with modules = obj.modules|filter_objects(
+          {% with namespaces = obj.namespaces|filter_objects(
               filters=config.filters,
               members_list=members_list,
               inherited_members=config.inherited_members,
+              private_members=config.private_members,
+              hidden_members=config.hidden_members,
               keep_no_docstrings=config.show_if_no_docstring,
             ) %}
-            {% if modules %}
+            {% if namespaces %}
               {% if config.show_category_heading %}
-                {% filter heading(heading_level, id=html_id ~ "-namespaces") %}Modules{% endfilter %}
+                {% filter heading(heading_level, id=html_id ~ "-namespaces") %}Namespaces{% 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 %}
+                {% for namespace in namespaces|order_members("alphabetical", members_list) %}
+                  {% include namespace|get_template %}
                 {% endfor %}
               {% endwith %}
             {% endif %}
@@ -151,35 +154,40 @@ Context:
             filters=config.filters,
             members_list=members_list,
             inherited_members=config.inherited_members,
+            private_members=config.private_members,
+            hidden_members=config.hidden_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 not (config.merge_constructor_into_class and obj.is_class and child.is_function and child.name == obj.name) %}
 
-          {% if members_list is not none or child.is_public %}
-            {% if child.is_attribute %}
-              {% with attribute = child %}
-                {% include attribute|get_template with context %}
-              {% endwith %}
+          {% if child.is_property %}
+            {% with property = child %}
+              {% include property|get_template %}
+            {% endwith %}
 
-            {% elif child.is_class %}
-              {% with class = child %}
-                {% include class|get_template with context %}
-              {% endwith %}
+          {% elif child.is_class %}
+            {% with class = child %}
+              {% include class|get_template %}
+            {% endwith %}
 
-            {% elif child.is_function %}
-              {% with function = child %}
-                {% include function|get_template with context %}
-              {% endwith %}
+          {% elif child.is_function %}
+            {% with function = child %}
+              {% include function|get_template %}
+            {% endwith %}
 
-            {% elif (child.is_namespace and config.show_subnamespaces) or obj.is_folder %}
-              {% with module = child %}
-                {% include module|get_template with context %}
-              {% endwith %}
+          {% elif child.is_script %}
+            {% with script = child %}
+              {% include script|get_template %}
+            {% endwith %}
+
+          {% elif (child.is_namespace and config.show_subnamespaces) or obj.is_folder %}
+            {% with namespace = child %}
+              {% include namespace|get_template %}
+            {% endwith %}
 
-            {% endif %}
           {% endif %}
 
         {% endif %}

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

@@ -0,0 +1,236 @@
+{#- Template for MATLAB classes.
+
+This template renders a MATLAB class.
+
+Context:
+  class (mkdocstrings_handlers.matlab.models.Class): The class 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 " + class.path) }}
+{% endblock logs %}
+
+<div class="doc doc-object doc-class">
+  {% with obj = class, html_id = class.path, all_members = class.all_members %}
+
+    {% 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 class_name = class.path if show_full_path else class.name %}
+
+    {% if not root or config.show_root_heading %}
+      {% filter heading(
+          heading_level,
+          role="class",
+          id=html_id,
+          class="doc doc-heading",
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else class.name),
+        ) %}
+
+        {% block heading scoped %}
+          {#- Heading block.
+
+          This block renders the heading for the class.
+          -#}
+          {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>{% endif %}
+          {% if config.separate_signature %}
+            <span class="doc doc-object-name doc-class-name">{{ config.heading if config.heading and root else class_name }}</span>
+          {% elif config.merge_constructor_into_class and class_name in all_members %}
+            {% with function = all_members[class_name] %}
+              {%+ filter highlight(language="matlab", inline=True) -%}
+                {{ class_name }}{% include "signature.html.jinja" with context %}
+              {%- endfilter %}
+            {% endwith %}
+          {% else %}
+            <code>{{ class_name }}</code>
+          {% endif %}
+        {% endblock heading %}
+
+        {% block attributes scoped %}
+          {#- attributes block.
+
+          This block renders the attributes for the class.
+          -#}
+          {% with attributes = class.attributes %}
+            {% include "attributes.html.jinja" with context %}
+          {% endwith %}
+        {% endblock attributes %}
+
+      {% endfilter %}
+
+      {% block signature scoped %}
+        {#- Signature block.
+
+        This block renders the signature for the class.
+        Overloads of the constructor method are rendered if `merge_constructor_into_class` is enabled.
+        The actual constructor method signature is only rendered if `separate_signature` is also enabled.
+        -#}
+        {% if config.merge_constructor_into_class %}
+          {% if class.name in all_members %}
+            {% with function = all_members[class.name] %}
+              {% if function.overloads and config.show_overloads %}
+                <div class="doc-overloads">
+                  {% for overload in function.overloads %}
+                    {% filter format_signature(overload, config.line_length, annotations=True, crossrefs=config.signature_crossrefs) %}
+                      {{ class.name }}
+                    {% endfilter %}
+                  {% endfor %}
+                </div>
+              {% endif %}
+              {% if config.separate_signature %}
+                {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
+                  {{ class.name }}
+                {% endfilter %}
+              {% endif %}
+            {% endwith %}
+          {% endif %}
+        {% endif %}
+      {% endblock signature %}
+
+    {% else %}
+      {% if config.show_root_toc_entry %}
+        {% filter heading(heading_level,
+            role="class",
+            id=html_id,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else class.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 class.
+        It contains other blocks that users can override.
+        Overriding the contents block allows to rearrange the order of the blocks.
+        -#}
+        {% block bases scoped %}
+          {#- Class bases block.
+
+          This block renders the bases for the class.
+          -#}
+          {% if config.show_bases and class.bases %}
+            <p class="doc doc-class-bases">
+              Bases: {% for expression in class.bases -%}
+                <code>
+                  {%- with backlink_type = "subclassed-by" -%}
+                    {%- include "expression.html.jinja" with context -%}
+                  {%- endwith -%}
+                </code>{% if not loop.last %}, {% endif %}
+              {% endfor -%}
+            </p>
+          {% endif %}
+        {% endblock bases %}
+
+        {% block diagram scoped %}
+
+        {% endblock diagram %}
+        {# This block renders the inheritance diagram #}
+          {% if config.show_inheritance_diagram and class.bases %}
+            {% with section = class | as_inheritance_diagram_section %}
+              {{ section.value|convert_markdown(heading_level, html_id) }}
+            {% endwith %}
+          {% endif %}
+        {% block docstring scoped %}
+          {#- Docstring block.
+
+          This block renders the docstring for the class.
+          -#}
+          {% with docstring_sections = class.docstring.parsed %}
+            {% include "docstring.html.jinja" with context %}
+          {% endwith %}
+          {% if config.merge_constructor_into_class and class.constructor %}
+            {# We don't want to merge the inherited constructor method docstring into the class docstring #}
+            {# if such inherited method was not selected through `inherited_members`. #}
+            {% with check_members = all_members if (config.inherited_members is true or (config.inherited_members is iterable and class.constructor.name in config.inherited_members)) else class.members %}
+              {% if class.constructor.name in check_members and class.constructor.has_docstring %}
+                {% with function = class.constructor %}
+                  {% with obj = function, docstring_sections = function | function_docstring(config.parse_arguments, config.show_docstring_input_arguments, config.show_docstring_name_value_arguments, config.show_docstring_output_arguments) %}
+                    {% include "docstring.html.jinja" with context %}
+                  {% endwith %}
+                {% endwith %}
+              {% endif %}
+            {% endwith %}
+          {% endif %}
+        {% endblock docstring %}
+
+        {% if config.backlinks %}
+          <backlinks identifier="{{ html_id }}" handler="python" />
+        {% endif %}
+
+        {% block summary scoped %}
+          {#- Summary block.
+
+          This block renders auto-summaries for classes, methods, and attributes.
+          -#}
+          {% include "summary.html.jinja" with context %}
+        {% endblock summary %}
+
+        {% block source scoped %}
+          {#- Source block.
+
+          This block renders the source code for the class.
+          -#}
+          {% if config.show_source %}
+            {% if config.merge_constructor_into_class %}
+              {% if class.constructor and class.constructor.source %}
+                {% with constructor = class.constructor %}
+                  <details class="quote">
+                    <summary>Source code in <code>
+                      {%- if constructor.relative_filepath.is_absolute() -%}
+                        {{ constructor.relative_package_filepath }}
+                      {%- else -%}
+                        {{ constructor.relative_filepath }}
+                      {%- endif -%}
+                    </code></summary>
+                    {{ constructor.source|highlight(language="matlab", linestart=constructor.lineno or 0, linenums=True) }}
+                  </details>
+                {% endwith %}
+              {% endif %}
+            {% elif class.source %}
+              <details class="quote">
+                <summary>Source code in <code>
+                  {%- if class.relative_filepath.is_absolute() -%}
+                    {{ class.relative_package_filepath }}
+                  {%- else -%}
+                    {{ class.relative_filepath }}
+                  {%- endif -%}
+                </code></summary>
+                {{ class.source|highlight(language="matlab", linestart=class.lineno or 0, linenums=True) }}
+              </details>
+            {% endif %}
+          {% endif %}
+        {% endblock source %}
+
+        {% block children scoped %}
+          {#- Children block.
+
+          This block renders the children (members) of the class.
+          -#}
+          {% set root = False %}
+          {% set heading_level = heading_level + 1 %}
+          {% include "children.html.jinja" with context %}
+        {% endblock children %}
+      {% endblock contents %}
+    </div>
+
+  {% endwith %}
+</div>

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

@@ -0,0 +1,20 @@
+{#- Template for admonitions in docstrings.
+
+This template renders admonitions using the `details` HTML element.
+
+Context:
+  section (griffe.DocstringSectionAdmonition): 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 admonition") }}
+{% endblock logs %}
+
+<details class="{{ section.value.kind }}" open>
+  <summary>{{ section.title|convert_markdown(heading_level, html_id, strip_paragraph=True, autoref_hook=autoref_hook) }}</summary>
+  {{ section.value.contents|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+</details>

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

@@ -0,0 +1,85 @@
+{#- Template for "Classes" sections in docstrings.
+
+This template renders a list of documented classes 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 classes section") }}
+{% endblock logs %}
+{% import "language.html.jinja" 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 lang.t("Classes:") }}</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>{{ lang.t("Name") }}</th>
+          <th>{{ lang.t("Description") }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for class in section.value %}
+          <tr class="doc-section-item">
+            <td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
+            <td>
+              <div class="doc-md-description">
+                {{ class.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 lang.t("Classes:") }}</span></p>
+    <ul>
+      {% for class in section.value %}
+        <li class="doc-section-item field-body">
+          <b><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></b>
+          –
+          <div class="doc-md-description">
+            {{ class.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 lang.t("CLASS")).rstrip(":").upper() }}</span></th>
+          <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for class in section.value %}
+          <tr class="doc-section-item">
+            <td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
+            <td class="doc-class-details">
+              <div class="doc-md-description">
+                {{ class.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/examples.html.jinja

@@ -0,0 +1,27 @@
+{#- Template for "Examples" sections in docstrings.
+
+This template renders a list of documented examples.
+It alternates between rendering text and code examples.
+
+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 examples section") }}
+{% endblock logs %}
+{% import "language.html.jinja" as lang with context %}
+{#- Language module providing the `t` translation method. -#}
+
+<p><span class="doc-section-title">{{ section.title or lang.t("Examples:") }}</span></p>
+{% for section_type, sub_section in section.value %}
+  {% if section_type.value == "text" %}
+    {{ sub_section|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+  {% elif section_type.value == "examples" %}
+    {{ sub_section|highlight(language="matlab") }}
+  {% endif %}
+{% endfor %}