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

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

@@ -1,9 +1,9 @@
-{#- Template for Python modules.
+{#- Template for MATLAB namespaces
 
-This template renders a Python module.
+This template renders a MATALB namespace.
 
 Context:
-  module (griffe.Module): The module to render.
+  namespace (griffe.namespace): The namespace 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.
@@ -11,14 +11,14 @@ Context:
 
 {% block logs scoped %}
   {#- Logging block.
-  
+
   This block can be used to log debug messages, deprecation messages, warnings, etc.
   -#}
-  {{ log.debug("Rendering " + module.path) }}
+  {{ log.debug("Rendering " + namespace.path) }}
 {% endblock logs %}
 
-<div class="doc doc-object doc-module">
-  {% with obj = module, html_id = module.path %}
+<div class="doc doc-object doc-namespace">
+  {% with obj = namespace, html_id = "+" + namespace.path %}
 
     {% if root %}
       {% set show_full_path = config.show_root_full_path %}
@@ -27,51 +27,41 @@ Context:
       {% 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 %}
+      {% set show_full_path = config.show_object_full_path %}"|get_template
     {% endif %}
 
-    {% set module_name = module.path + ".*" if show_full_path else module.name + ".*" %}
+    {% set namespace_name = namespace.path + ".*" if show_full_path else namespace.name + ".*" %}
 
     {% if not root or config.show_root_heading %}
       {% filter heading(
           heading_level,
-          role="module",
+          role="namespace",
           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,
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-namespace"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else namespace.name),
         ) %}
 
         {% block heading scoped %}
           {#- Heading block.
-          
-          This block renders the heading for the module.
+
+          This block renders the heading for the namespace.
           -#}
           {% 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>
+            <span class="doc doc-object-name doc-namespace-name">{{ config.heading if config.heading and root else namespace_name }}</span>
           {% else %}
-            <code>{{ module_name }}</code>
+            <code>{{ namespace_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",
+            role="namespace",
             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,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-namespace"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else namespace.name),
             hidden=True,
           ) %}
         {% endfilter %}
@@ -82,37 +72,41 @@ Context:
     <div class="doc doc-contents {% if root %}first{% endif %}">
       {% block contents scoped %}
         {#- Contents block.
-        
-        This block renders the contents of the module.
+
+        This block renders the contents of the namespace.
         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.
+
+          This block renders the docstring for the namespace.
           -#}
-          {% with docstring_sections = module.docstring.parsed %}
-            {% include "docstring"|get_template with context %}
+          {% with docstring_sections = namespace.docstring.parsed %}
+            {% include "docstring.html.jinja" with context %}
           {% endwith %}
         {% 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"|get_template with context %}
+          {% include "summary.html.jinja" with context %}
         {% endblock summary %}
 
         {% block children scoped %}
           {#- Children block.
-          
-          This block renders the children (members) of the module.
+
+          This block renders the children (members) of the namespace.
           -#}
           {% set root = False %}
           {% set heading_level = heading_level + 1 %}
-          {% include "children"|get_template with context %}
+          {% include "children.html.jinja" with context %}
         {% endblock children %}
       {% endblock contents %}
     </div>

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

@@ -1,25 +1,25 @@
-{#- Template for Python attributes.
+{#- Template for MATLAB properties.
 
-This template renders a Python attribute (or variable).
-This can be a module attribute or a class attribute.
+This template renders a MATLAB class property.
 
 Context:
-  attribute (griffe.Attribute): The attribute to render.
+  property (mkdocstrings_handlers.matlab.models.Property): The property 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) }}
+  {{ log.debug("Rendering " + property.path) }}
 {% endblock logs %}
 
-<div class="doc doc-object doc-attribute">
-  {% with obj = attribute, html_id = attribute.path %}
+<div class="doc doc-object doc-property">
+  {% with obj = property, html_id = property.path %}
 
     {% if root %}
       {% set show_full_path = config.show_root_full_path %}
@@ -31,53 +31,53 @@ Context:
       {% set show_full_path = config.show_object_full_path %}
     {% endif %}
 
-    {% set attribute_name = attribute.path if show_full_path else attribute.name %}
+    {% set property_name = property.path if show_full_path else property.name %}
 
     {% if not root or config.show_root_heading %}
       {% filter heading(
           heading_level,
-          role="data" if attribute.parent.kind.value == "module" else "attr",
+          role="data" if property.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,
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-property"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else property_name),
         ) %}
 
         {% block heading scoped %}
           {#- Heading block.
-          
-          This block renders the heading for the attribute.
+
+          This block renders the heading for the property.
           -#}
           {% 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>
+            <span class="doc doc-object-name doc-property-name">{{ config.heading if config.heading and root else property_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 %}
+              {{ property_name }}{% if property.annotation and config.show_signature_types %}: {{ property.annotation }}{% endif %}
+              {% if property.value %} = {{ property.value }}{% endif %}
             {% endfilter %}
           {% endif %}
         {% endblock heading %}
 
-        {% block labels scoped %}
-          {#- Labels block.
-          
-          This block renders the labels for the attribute.
+        {% block attributes scoped %}
+          {#- attributes block.
+
+          This block renders the attributes for the property.
           -#}
-          {% with labels = attribute.labels %}
-            {% include "labels"|get_template with context %}
+          {% with attributes = property.attributes %}
+            {% include "attributes.html.jinja" with context %}
           {% endwith %}
-        {% endblock labels %}
+        {% endblock attributes %}
 
       {% endfilter %}
 
       {% block signature scoped %}
         {#- Signature block.
-        
-        This block renders the signature for the attribute.
+
+        This block renders the signature for the property.
         -#}
         {% if config.separate_signature %}
-          {% filter format_attribute(attribute, config.line_length, crossrefs=config.signature_crossrefs) %}
-            {{ attribute.name }}
+          {% filter format_property(property, config.line_length, crossrefs=config.signature_crossrefs) %}
+            {{ property.name }}
           {% endfilter %}
         {% endif %}
       {% endblock signature %}
@@ -86,9 +86,9 @@ Context:
 
       {% if config.show_root_toc_entry %}
         {% filter heading(heading_level,
-            role="data" if attribute.parent.kind.value == "module" else "attr",
+            role="data" if property.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,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-property"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else property_name),
             hidden=True,
           ) %}
         {% endfilter %}
@@ -99,20 +99,24 @@ Context:
     <div class="doc doc-contents {% if root %}first{% endif %}">
       {% block contents scoped %}
         {#- Contents block.
-        
-        This block renders the contents of the attribute.
+
+        This block renders the contents of the property.
         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.
+
+          This block renders the docstring for the property.
           -#}
-          {% with docstring_sections = attribute.docstring.parsed %}
-            {% include "docstring"|get_template with context %}
+          {% with docstring_sections = property.docstring.parsed %}
+            {% include "docstring.html.jinja" with context %}
           {% endwith %}
         {% endblock docstring %}
+
+        {% if config.backlinks %}
+          <backlinks identifier="{{ html_id }}" handler="python" />
+        {% endif %}
       {% endblock contents %}
     </div>
 

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

@@ -17,7 +17,7 @@ Context:
   {{ log.debug("Rendering " + script.path) }}
 {% endblock logs %}
 
-<div class="doc doc-object doc-function">
+<div class="doc doc-object doc-script">
   {% with obj = script, html_id = script.path %}
 
     {% if root %}
@@ -56,30 +56,8 @@ Context:
           {% endif %}
         {% endblock heading %}
 
-        {% block labels scoped %}
-          {#- Labels block.
-          
-          This block renders the labels for the script.
-          -#}
-          {% with labels = script.labels %}
-            {% include "labels"|get_template with context %}
-          {% endwith %}
-        {% endblock labels %}
-
       {% endfilter %}
 
-      {% block signature scoped %}
-        {#- Signature block.
-        
-        This block renders the signature for the script.
-        -#}
-        {% if config.separate_signature %}
-          {% filter format_signature(script, config.line_length, crossrefs=config.signature_crossrefs) %}
-            {{ script.name }}
-          {% endfilter %}
-        {% endif %}
-      {% endblock signature %}
-
     {% else %}
 
       {% if config.show_root_toc_entry %}
@@ -108,7 +86,7 @@ Context:
           This block renders the docstring for the script.
           -#}
           {% with docstring_sections = script.docstring.parsed %}
-            {% include "docstring"|get_template with context %}
+            {% include "docstring.html.jinja" with context %}
           {% endwith %}
         {% endblock docstring %}
 
@@ -126,7 +104,7 @@ Context:
                   {{ script.relative_filepath }}
                 {%- endif -%}
               </code></summary>
-              {{ script.source|highlight(language="python", linestart=script.lineno or 0, linenums=True) }}
+              {{ script.source|highlight(language="matlab", linestart=script.lineno or 0, linenums=True) }}
             </details>
           {% endif %}
         {% endblock source %}

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

@@ -0,0 +1,105 @@
+{#- Template for signatures.
+
+This template renders the signature of a function or method.
+It iterates over the arguments of the function to rebuild the signature.
+The signature is the list of arguments of a function or method, including their names, default values, and types.
+
+Context:
+  function (mkdocstrings_handlers.matlab.models.Function): The function or method to render.
+  config (dict): The configuration options.
+-#}
+
+{%- if config.show_signature -%}
+  {%- block logs scoped -%}
+    {#- Logging block.
+
+    This block can be used to log debug messages, deprecation messages, warnings, etc.
+    -#}
+    {{ log.debug("Rendering signature") }}
+  {%- endblock logs -%}
+  {%- with -%}
+
+    {%- set ns = jinja_namespace(
+        type="",
+        equal="=",
+        default=False,
+      ) -%}
+
+    (
+    {%- for argument in function.arguments -%}
+      {%- if argument.name != "obj" or loop.index0 > 0 or not (function.parent and function.parent.is_class) -%}
+
+        {#- Prepare types. -#}
+        {%- if config.show_signature_types and argument.type is not none -%}
+          {%- set ns.equal = " = " -%}
+          {%- if config.separate_signature -%}
+            {%- with expression = argument.type -%}
+              {%- set ns.type -%}: {% with backlink_type = "used-by" -%}
+                {%- include "expression.html.jinja" with context -%}
+              {%- endwith -%}{%- endset -%}
+            {%- endwith -%}
+          {%- else -%}
+            {%- set ns.type = ": " + argument.type|safe -%}
+          {%- endif -%}
+        {%- else -%}
+          {%- set ns.equal = "=" -%}
+          {%- set ns.type = "" -%}
+        {%- endif -%}
+
+        {#- Prepare default value. -#}
+        {%- if argument.default is not none and argument.kind.value != "varargin" -%}
+          {%- set ns.default = True -%}
+        {%- else -%}
+          {%- set ns.default = False -%}
+        {%- endif -%}
+
+        {#- Render argument name with optional cross-reference to its heading. -#}
+        {%- if config.separate_signature and config.argument_headings and config.signature_crossrefs -%}
+          {%- filter stash_crossref(length=argument.name|length) -%}
+            {%- with func_path = function.path -%}
+              {%- if config.merge_constructor_into_class and function.parent and function.parent.is_class and function.name == function.parent.name -%}
+                {%- set func_path = func_path[:-((function.parent | length) + 1)] -%}
+              {%- endif -%}
+              <autoref identifier="{{ func_path }}({{ argument.name }})" optional>{{ argument.name }}</autoref>
+            {%- endwith -%}
+          {%- endfilter -%}
+        {%- else -%}
+          {{ argument.name }}
+        {%- endif -%}
+
+        {#- Render argument type. -#}
+        {{ ns.type }}
+
+        {#- Render argument default value. -#}
+        {%- if ns.default -%}
+          {{ ns.equal }}
+          {%- if config.signature_crossrefs and config.separate_signature -%}
+            {%- with expression = argument.default, backlink_type = "used-by" -%}
+              {%- include "expression.html.jinja" with context -%}
+            {%- endwith -%}
+          {%- else -%}
+            {{ argument.default|safe }}
+          {%- endif -%}
+        {%- endif -%}
+
+        {%- if not loop.last %}, {% endif -%}
+
+      {%- endif -%}
+    {%- endfor -%}
+    )
+
+    {#- Render return type. -#}
+    {%- if config.show_signature_types
+        and function.type
+        and not (config.merge_constructor_into_class and function.parent and function.parent.is_class and function.name == function.parent.name)
+      %} -> {% if config.separate_signature and config.signature_crossrefs -%}
+        {%- with expression = function.type, backlink_type = "returned-by" -%}
+          {%- include "expression.html.jinja" with context -%}
+        {%- endwith -%}
+      {%- else -%}
+        {{ function.type|safe }}
+      {%- endif -%}
+    {%- endif -%}
+
+  {%- endwith -%}
+{%- endif -%}

mkdocstrings_handlers/matlab/templates/material/style.css

@@ -1,3 +1,173 @@
+/* Avoid breaking argument names, etc. in table cells. */
+.doc-contents td code {
+  word-break: normal !important;
+}
+
+/* No line break before first paragraph of descriptions. */
+.doc-md-description,
+.doc-md-description>p:first-child {
+  display: inline;
+}
+
+/* Max width for docstring sections tables. */
+.doc .md-typeset__table,
+.doc .md-typeset__table table {
+  display: table !important;
+  width: 100%;
+}
+
+.doc .md-typeset__table tr {
+  display: table-row;
+}
+
+/* Defaults in Spacy table style. */
+.doc-argument-default {
+  float: right;
+}
+
+/* Argument headings must be inline, not blocks. */
+.doc-heading-argument {
+  display: inline;
+}
+
+/* Prefer space on the right, not the left of argument permalinks. */
+.doc-heading-argument .headerlink {
+  margin-left: 0 !important;
+  margin-right: 0.2rem;
+}
+
+/* Backward-compatibility: docstring section titles in bold. */
+.doc-section-title {
+  font-weight: bold;
+}
+
+/* Backlinks crumb separator. */
+.doc-backlink-crumb {
+  display: inline-flex;
+  gap: .2rem;
+  white-space: nowrap;
+  align-items: center;
+  vertical-align: middle;
+}
+.doc-backlink-crumb:not(:first-child)::before {
+  background-color: var(--md-default-fg-color--lighter);
+  content: "";
+  display: inline;
+  height: 1rem;
+  --md-path-icon: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M8.59 16.58 13.17 12 8.59 7.41 10 6l6 6-6 6z"/></svg>');
+  -webkit-mask-image: var(--md-path-icon);
+  mask-image: var(--md-path-icon);
+  width: 1rem;
+}
+.doc-backlink-crumb.last {
+  font-weight: bold;
+}
+
+/* Symbols in Navigation and ToC. */
+:root, :host,
+[data-md-color-scheme="default"] {
+  --doc-symbol-argument-fg-color: #df50af;
+  --doc-symbol-property-fg-color: #953800;
+  --doc-symbol-script-fg-color: #d0bf3d;
+  --doc-symbol-function-fg-color: #8250df;
+  --doc-symbol-method-fg-color: #8250df;
+  --doc-symbol-class-fg-color: #0550ae;
+  --doc-symbol-module-fg-color: #5cad0f;
+
+  --doc-symbol-argument-bg-color: #df50af1a;
+  --doc-symbol-property-bg-color: #9538001a;
+  --doc-symbol-script-bg-color: #96862f27;
+  --doc-symbol-function-bg-color: #8250df1a;
+  --doc-symbol-method-bg-color: #8250df1a;
+  --doc-symbol-class-bg-color: #0550ae1a;
+  --doc-symbol-module-bg-color: #5cad0f1a;
+}
+
+[data-md-color-scheme="slate"] {
+  --doc-symbol-argument-fg-color: #ffa8cc;
+  --doc-symbol-property-fg-color: #ffa657;
+  --doc-symbol-script-fg-color: #f0d78a;
+  --doc-symbol-function-fg-color: #d2a8ff;
+  --doc-symbol-method-fg-color: #d2a8ff;
+  --doc-symbol-class-fg-color: #79c0ff;
+  --doc-symbol-module-fg-color: #baff79;
+
+  --doc-symbol-argument-bg-color: #ffa8cc1a;
+  --doc-symbol-property-bg-color: #ffa6571a;
+  --doc-symbol-script-bg-color: #f0d78a1a;
+  --doc-symbol-function-bg-color: #d2a8ff1a;
+  --doc-symbol-method-bg-color: #d2a8ff1a;
+  --doc-symbol-class-bg-color: #79c0ff1a;
+  --doc-symbol-module-bg-color: #baff791a;
+}
+
+code.doc-symbol {
+  border-radius: .1rem;
+  font-size: .85em;
+  padding: 0 .3em;
+  font-weight: bold;
+}
+
+code.doc-symbol-argument,
+a code.doc-symbol-argument {
+  color: var(--doc-symbol-argument-fg-color);
+  background-color: var(--doc-symbol-argument-bg-color);
+}
+
+code.doc-symbol-argument::after {
+  content: "arg";
+}
+
+code.doc-symbol-property,
+a code.doc-symbol-property {
+  color: var(--doc-symbol-property-fg-color);
+  background-color: var(--doc-symbol-property-bg-color);
+}
+
+code.doc-symbol-property::after {
+  content: "prop";
+}
+
+code.doc-symbol-function,
+a code.doc-symbol-function {
+  color: var(--doc-symbol-function-fg-color);
+  background-color: var(--doc-symbol-function-bg-color);
+}
+
+code.doc-symbol-function::after {
+  content: "func";
+}
+
+code.doc-symbol-method,
+a code.doc-symbol-method {
+  color: var(--doc-symbol-method-fg-color);
+  background-color: var(--doc-symbol-method-bg-color);
+}
+
+code.doc-symbol-method::after {
+  content: "meth";
+}
+
+code.doc-symbol-class,
+a code.doc-symbol-class {
+  color: var(--doc-symbol-class-fg-color);
+  background-color: var(--doc-symbol-class-bg-color);
+}
+
+code.doc-symbol-class::after {
+  content: "class";
+}
+
+code.doc-symbol-module,
+a code.doc-symbol-module {
+  color: var(--doc-symbol-module-fg-color);
+  background-color: var(--doc-symbol-module-bg-color);
+}
+
+code.doc-symbol-module::after {
+  content: "mod";
+}
+
 code.doc-symbol-namespace {
   color: var(--doc-symbol-module-fg-color);
   background-color: var(--doc-symbol-module-bg-color);
@@ -17,8 +187,8 @@ code.doc-symbol-folder::after {
 }
 
 code.doc-symbol-property {
-  color: var(--doc-symbol-attribute-fg-color);
-  background-color: var(--doc-symbol-attribute-bg-color);
+  color: var(--doc-symbol-property-fg-color);
+  background-color: var(--doc-symbol-property-bg-color);
 }
 
 code.doc-symbol-property::after {
@@ -26,10 +196,15 @@ code.doc-symbol-property::after {
 }
 
 code.doc-symbol-script {
-  color: #d0bf3d;
-  background-color: #96862f27;
+  color: var(--doc-symbol-script-fg-color);
+  background-color: var(--doc-symbol-script-bg-color);
 }
 
 code.doc-symbol-script::after {
   content: "script";
 }
+
+.doc-signature .autorefs {
+  color: inherit;
+  border-bottom: 1px dotted currentcolor;
+}

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

@@ -0,0 +1,25 @@
+{#- Summary of classes. -#}
+
+{% block logs scoped %}
+  {#- Logging block.
+
+  This block can be used to log debug messages, deprecation messages, warnings, etc.
+  -#}
+{% endblock logs %}
+
+{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "classes") | list %}
+  {% with section = obj.classes
+      |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,
+      )
+      |order_members(config.members_order, members_list)
+      |as_classes_section(check_public=not members_list)
+    %}
+    {% if section %}{% include "docstring/classes.html.jinja" with context %}{% endif %}
+  {% endwith %}
+{% endif %}