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

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

@@ -0,0 +1,91 @@
+{#- Template for "Functions" sections in docstrings.
+
+This template renders a list of documented functions 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 functions 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("Methods:") if obj.is_class else lang.t("Functions:") }}</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>{{ lang.t("Name") }}</th>
+          <th>{{ lang.t("Description") }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for function in section.value %}
+          {% if not function.name == "__init__" or not config.merge_init_into_class %}
+            <tr class="doc-section-item">
+              <td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
+              <td>
+                <div class="doc-md-description">
+                  {{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+                </div>
+              </td>
+            </tr>
+          {% endif %}
+        {% 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("Methods:") if obj.is_class else lang.t("Functions:") }}</span></p>
+    <ul>
+      {% for function in section.value %}
+        {% if not function.name == "__init__" or not config.merge_init_into_class %}
+          <li class="doc-section-item field-body">
+            <b><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></b>
+            –
+            <div class="doc-md-description">
+              {{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+            </div>
+          </li>
+        {% endif %}
+      {% 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("METHOD") if obj.is_class else lang.t("FUNCTION")).rstrip(":").upper() }}</span></th>
+          <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for function in section.value %}
+          {% if not function.name == "__init__" or not config.merge_init_into_class %}
+            <tr class="doc-section-item">
+              <td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
+              <td class="doc-function-details">
+                <div class="doc-md-description">
+                  {{ function.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+                </div>
+              </td>
+            </tr>
+          {% endif %}
+        {% endfor %}
+      </tbody>
+    </table>
+  {% endblock spacy_style %}
+{% endif %}

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

@@ -0,0 +1,171 @@
+{#- Template for "Input arguments" sections in docstrings.
+
+This template renders a list of documented input arguments 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 input arguments 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("Input arguments:") }}</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>{{ lang.t("Name") }}</th>
+          <th>{{ lang.t("Type") }}</th>
+          <th>{{ lang.t("Description") }}</th>
+          <th>{{ lang.t("Default") }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for argument in section.value %}
+          <tr class="doc-section-item">
+            <td>
+              {% if config.argument_headings %}
+                {% filter heading(
+                    heading_level + 1,
+                    role="argument",
+                    id=html_id ~ "(" ~ argument.name ~ ")",
+                    class="doc doc-heading doc-heading-argument",
+                    toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+                  ) %}
+                  <code>{{ argument.name }}</code>
+                {% endfilter %}
+              {% else %}
+                <code>{{ argument.name }}</code>
+              {% endif %}
+            </td>
+            <td>
+              {% if argument.annotation %}
+                {% with expression = argument.annotation, backlink_type = "used-by" %}
+                  <code>{% include "expression.html.jinja" with context %}</code>
+                {% endwith %}
+              {% endif %}
+            </td>
+            <td>
+              <div class="doc-md-description">
+                {{ argument.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+            </td>
+            <td>
+              {% if argument.default %}
+                {% with expression = argument.default, backlink_type = "used-by" %}
+                  <code>{% include "expression.html.jinja" with context %}</code>
+                {% endwith %}
+              {% else %}
+                <em>{{ lang.t("required") }}</em>
+              {% endif %}
+            </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("Input arguments:") }}</span></p>
+    <ul>
+      {% for argument in section.value %}
+        <li class="doc-section-item field-body">
+          {% if config.argument_headings %}
+            {% filter heading(
+                heading_level + 1,
+                role="argument",
+                id=html_id ~ "(" ~ argument.name ~ ")",
+                class="doc doc-heading doc-heading-argument",
+                toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+              ) %}
+              <b><code>{{ argument.name }}</code></b>
+            {% endfilter %}
+          {% else %}
+            <b><code>{{ argument.name }}</code></b>
+          {% endif %}
+          {% if argument.annotation %}
+            {% with expression = argument.annotation, backlink_type = "used-by" %}
+              (<code>{% include "expression.html.jinja" with context %}</code>
+              {%- if argument.default %}, {{ lang.t("default:") }}
+                {% with expression = argument.default, backlink_type = "used-by" %}
+                  <code>{% include "expression.html.jinja" with context %}</code>
+                {% endwith %}
+              {% endif %})
+            {% endwith %}
+          {% endif %}
+          –
+          <div class="doc-md-description">
+            {{ argument.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("INPUT ARGUMENT")).rstrip(":").upper() }}</span></th>
+          <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for argument in section.value %}
+          <tr class="doc-section-item">
+            <td>
+              {% if config.argument_headings %}
+                {% filter heading(
+                    heading_level + 1,
+                    role="argument",
+                    id=html_id ~ "(" ~ argument.name ~ ")",
+                    class="doc doc-heading doc-heading-argument",
+                    toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+                  ) %}
+                  <code>{{ argument.name }}</code>
+                {% endfilter %}
+              {% else %}
+                <code>{{ argument.name }}</code>
+              {% endif %}
+            </td>
+            <td class="doc-argument-details">
+              <div class="doc-md-description">
+                {{ argument.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+              <p>
+                {% if argument.annotation %}
+                  <span class="doc-argument-annotation">
+                    <b>{{ lang.t("TYPE:") }}</b>
+                    {% with expression = argument.annotation, backlink_type = "used-by" %}
+                      <code>{% include "expression.html.jinja" with context %}</code>
+                    {% endwith %}
+                  </span>
+                {% endif %}
+                {% if argument.default %}
+                  <span class="doc-argument-default">
+                    <b>{{ lang.t("DEFAULT:") }}</b>
+                    {% with expression = argument.default, backlink_type = "used-by" %}
+                      <code>{% include "expression.html.jinja" with context %}</code>
+                    {% endwith %}
+                  </span>
+                {% endif %}
+              </p>
+            </td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  {% endblock spacy_style %}
+{% endif %}

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

@@ -0,0 +1,166 @@
+{#- Template for "Name-value arguments" sections in docstrings.
+
+This template renders a list of documented name-value arguments 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 name-value arguments 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("Name-value arguments:") }}</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>{{ lang.t("Name") }}</th>
+          <th>{{ lang.t("Type") }}</th>
+          <th>{{ lang.t("Description") }}</th>
+          <th>{{ lang.t("Default") }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for argument in section.value %}
+          <tr class="doc-section-item">
+            <td>
+              {% if config.argument_headings %}
+                {% filter heading(
+                    heading_level + 1,
+                    role="argument",
+                    id=html_id ~ "(" ~ argument.name ~ ")",
+                    class="doc doc-heading doc-heading-argument",
+                    toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+                  ) %}
+                  <code>{{ argument.name }}</code>
+                {% endfilter %}
+              {% else %}
+                <code>{{ argument.name }}</code>
+              {% endif %}
+            </td>
+            <td>
+              {% if argument.annotation %}
+                {% with expression = argument.annotation, backlink_type = "used-by" %}
+                  <code>{% include "expression.html.jinja" with context %}</code>
+                {% endwith %}
+              {% endif %}
+            </td>
+            <td>
+              <div class="doc-md-description">
+                {{ argument.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+            </td>
+            <td>
+              {% if argument.default %}
+                {% with expression = argument.default, backlink_type = "used-by" %}
+                  <code>{% include "expression.html.jinja" with context %}</code>
+                {% endwith %}
+              {% else %}
+                <em>{{ lang.t("none") }}</em>
+              {% endif %}
+            </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("Name-value arguments:") }}</span></p>
+    <ul>
+      {% for argument in section.value %}
+        <li class="doc-section-item field-body">
+          {% if config.argument_headings %}
+            {% filter heading(
+                heading_level + 1,
+                role="argument",
+                id=html_id ~ "(" ~ argument.name ~ ")",
+                class="doc doc-heading doc-heading-argument",
+                toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+              ) %}
+              <b><code>{{ argument.name }}</code></b>
+            {% endfilter %}
+          {% else %}
+            <b><code>{{ argument.name }}</code></b>
+          {% endif %}
+          {% if argument.annotation %}
+            {% with expression = argument.annotation, backlink_type = "used-by" %}
+              (<code>{% include "expression.html.jinja" with context %}</code>)
+            {% endwith %}
+          {% endif %}
+          –
+          <div class="doc-md-description">
+            {{ argument.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("NAME-VALUE ARGUMENT")).rstrip(":").upper() }}</span></th>
+          <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for argument in section.value %}
+          <tr class="doc-section-item">
+            <td>
+              {% if config.argument_headings %}
+                {% filter heading(
+                    heading_level + 1,
+                    role="argument",
+                    id=html_id ~ "(" ~ argument.name ~ ")",
+                    class="doc doc-heading doc-heading-argument",
+                    toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+                  ) %}
+                  <code>{{ argument.name }}</code>
+                {% endfilter %}
+              {% else %}
+                <code>{{ argument.name }}</code>
+              {% endif %}
+            </td>
+            <td class="doc-argument-details">
+              <div class="doc-md-description">
+                {{ argument.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+              <p>
+                {% if argument.annotation %}
+                  <span class="doc-argument-annotation">
+                    <b>{{ lang.t("TYPE:") }}</b>
+                    {% with expression = argument.annotation, backlink_type = "used-by" %}
+                      <code>{% include "expression.html.jinja" with context %}</code>
+                    {% endwith %}
+                  </span>
+                {% endif %}
+                {% if argument.default %}
+                  <span class="doc-argument-default">
+                    <b>{{ lang.t("DEFAULT:") }}</b>
+                    {% with expression = argument.default, backlink_type = "used-by" %}
+                      <code>{% include "expression.html.jinja" with context %}</code>
+                    {% endwith %}
+                  </span>
+                {% endif %}
+              </p>
+            </td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  {% endblock spacy_style %}
+{% endif %}

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

@@ -9,19 +9,18 @@ Context:
 
 {% 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 %}
+{% 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 "Namespaces:" }}</span></p>
+    <p><span class="doc-section-title">{{ section.title or lang.t("Namespaces:") }}</span></p>
     <table>
       <thead>
         <tr>
@@ -46,7 +45,7 @@ Context:
 {% 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>
+    <p><span class="doc-section-title">{{ section.title or lang.t("Namespaces:") }}</span></p>
     <ul>
       {% for module in section.value %}
         <li class="doc-section-item field-body">
@@ -65,7 +64,7 @@ Context:
     <table>
       <thead>
         <tr>
-          <th><span class="doc-section-title">{{ (section.title or "NAMESPACE:").rstrip(":").upper() }}</span></th>
+          <th><span class="doc-section-title">{{ (section.title or lang.t("NAMESPACE:")).rstrip(":").upper() }}</span></th>
           <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
         </tr>
       </thead>

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

@@ -0,0 +1,152 @@
+{#- Template for "Output arguments" sections in docstrings.
+
+This template renders a list of documented output arguments 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 output arguments 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("Output arguments:") }}</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>{{ lang.t("Name") }}</th>
+          <th>{{ lang.t("Type") }}</th>
+          <th>{{ lang.t("Description") }}</th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for argument in section.value %}
+          <tr class="doc-section-item">
+            <td>
+              {% if config.argument_headings %}
+                {% filter heading(
+                    heading_level + 1,
+                    role="argument",
+                    id=html_id ~ "(" ~ argument.name ~ ")",
+                    class="doc doc-heading doc-heading-argument",
+                    toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+                  ) %}
+                  <code>{{ argument.name }}</code>
+                {% endfilter %}
+              {% else %}
+                <code>{{ argument.name }}</code>
+              {% endif %}
+            </td>
+            <td>
+              {% if argument.annotation %}
+                {% with expression = argument.annotation, backlink_type = "returned-by" %}
+                  <code>{% include "expression.html.jinja" with context %}</code>
+                {% endwith %}
+              {% endif %}
+            </td>
+            <td>
+              <div class="doc-md-description">
+                {{ argument.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("Output arguments:") }}</span></p>
+    <ul>
+      {% for argument in section.value %}
+        <li class="doc-section-item field-body">
+          {% if config.argument_headings %}
+            {% filter heading(
+                heading_level + 1,
+                role="argument",
+                id=html_id ~ "(" ~ argument.name ~ ")",
+                class="doc doc-heading doc-heading-argument",
+                toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+              ) %}
+              <b><code>{{ argument.name }}</code></b>
+            {% endfilter %}
+          {% else %}
+            <b><code>{{ argument.name }}</code></b>
+          {% endif %}
+          {% if argument.annotation %}
+            {% with expression = argument.annotation, backlink_type = "returned-by" %}
+              {% if argument.name %} ({% endif %}
+              <code>{% include "expression.html.jinja" with context %}</code>
+              {% if argument.name %}){% endif %}
+            {% endwith %}
+          {% endif %}
+          –
+          <div class="doc-md-description">
+            {{ argument.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("OUTPUT ARGUMENT")).rstrip(":").upper() }}</span></th>
+          <th><span>{{ lang.t("DESCRIPTION").upper() }}</span></th>
+        </tr>
+      </thead>
+      <tbody>
+        {% for argument in section.value %}
+          <tr class="doc-section-item">
+            <td>
+              {% if config.argument_headings %}
+                {% filter heading(
+                    heading_level + 1,
+                    role="argument",
+                    id=html_id ~ "(" ~ argument.name ~ ")",
+                    class="doc doc-heading doc-heading-argument",
+                    toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-argument"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + argument.name,
+                  ) %}
+                  <code>{{ argument.name }}</code>
+                {% endfilter %}
+              {% else %}
+                <code>{{ argument.name }}</code>
+              {% endif %}
+            </td>
+            <td class="doc-argument-details">
+              <div class="doc-md-description">
+                {{ argument.description|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
+              </div>
+              {% if argument.name and argument.annotation %}
+                <p>
+                {% if argument.annotation %}
+                  <span class="doc-argument-annotation">
+                    <b>{{ lang.t("TYPE:") }}</b>
+                    {% with expression = argument.annotation, backlink_type = "used-by" %}
+                      <code>{% include "expression.html.jinja" with context %}</code>
+                    {% endwith %}
+                  </span>
+                {% endif %}
+                </p>
+              {% endif %}
+            </td>
+          </tr>
+        {% endfor %}
+      </tbody>
+    </table>
+  {% endblock spacy_style %}
+{% endif %}