mkdocstrings-python 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

mkdocstrings_handlers/python/handler.py

@@ -297,7 +297,8 @@ class PythonHandler(BaseHandler):
         mutabled_config = dict(copy.deepcopy(config))
         final_config = ChainMap(mutabled_config, self.default_config)
 
-        template = self.env.get_template(f"{data.kind.value}.html")
+        template_name = rendering.do_get_template(data)
+        template = self.env.get_template(template_name)
 
         # Heading level is a "state" variable, that will change at each step
         # of the rendering recursion. Therefore, it's easier to use it as a plain value
@@ -335,6 +336,7 @@ class PythonHandler(BaseHandler):
         self.env.filters["format_signature"] = rendering.do_format_signature
         self.env.filters["filter_objects"] = rendering.do_filter_objects
         self.env.filters["stash_crossref"] = lambda ref, length: ref
+        self.env.filters["get_template"] = rendering.do_get_template
 
     def get_anchors(self, data: CollectorItem) -> set[str]:  # noqa: D102 (ignore missing docstring)
         try:

mkdocstrings_handlers/python/rendering.py

@@ -248,3 +248,16 @@ def _get_black_formatter() -> Callable[[str, int], str]:
         return format_str(code, mode=mode)
 
     return formatter
+
+
+def do_get_template(obj: Object) -> str:
+    """Get the template name used to render an object.
+
+    Parameters:
+        obj: A Griffe object.
+
+    Returns:
+        A template name.
+    """
+    extra_data = getattr(obj, "extra", {}).get("mkdocstrings", {})
+    return extra_data.get("template", "") or f"{obj.kind.value}.html"

mkdocstrings_handlers/python/templates/material/_base/children.html

@@ -27,7 +27,7 @@
             {% with heading_level = heading_level + extra_level %}
               {% for attribute in attributes|order_members(config.members_order, members_list) %}
                 {% if not attribute.is_alias or attribute.is_explicitely_exported %}
-                  {% include "attribute.html" with context %}
+                  {% include attribute|get_template with context %}
                 {% endif %}
               {% endfor %}
             {% endwith %}
@@ -42,7 +42,7 @@
             {% with heading_level = heading_level + extra_level %}
               {% for class in classes|order_members(config.members_order, members_list) %}
                 {% if not class.is_alias or class.is_explicitely_exported %}
-                  {% include "class.html" with context %}
+                  {% include class|get_template with context %}
                 {% endif %}
               {% endfor %}
             {% endwith %}
@@ -58,7 +58,7 @@
               {% 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 not function.is_alias or function.is_explicitely_exported %}
-                    {% include "function.html" with context %}
+                    {% include function|get_template with context %}
                   {% endif %}
                 {% endif %}
               {% endfor %}
@@ -75,7 +75,7 @@
               {% with heading_level = heading_level + extra_level %}
                 {% for module in modules|order_members(config.members_order, members_list) %}
                   {% if not module.is_alias or module.is_explicitely_exported %}
-                    {% include "module.html" with context %}
+                    {% include module|get_template with context %}
                   {% endif %}
                 {% endfor %}
               {% endwith %}
@@ -91,26 +91,26 @@
           filter_objects(filters=config.filters, members_list=members_list, keep_no_docstrings=config.show_if_no_docstring)|
           order_members(config.members_order, members_list) %}
 
-        {% if not (obj.kind.value == "class" and child.name == "__init__" and config.merge_init_into_class) %}
+        {% if not (obj.is_class and child.name == "__init__" and config.merge_init_into_class) %}
 
-          {% if child.kind.value == "attribute" %}
+          {% if child.is_attribute %}
             {% with attribute = child %}
-              {% include "attribute.html" with context %}
+              {% include attribute|get_template with context %}
             {% endwith %}
 
-          {% elif child.kind.value == "class" %}
+          {% elif child.is_class %}
             {% with class = child %}
-              {% include "class.html" with context %}
+              {% include class|get_template with context %}
             {% endwith %}
 
-          {% elif child.kind.value == "function" %}
+          {% elif child.is_function %}
             {% with function = child %}
-              {% include "function.html" with context %}
+              {% include function|get_template with context %}
             {% endwith %}
 
-          {% elif child.kind.value == "module" and config.show_submodules %}
+          {% elif child.is_module and config.show_submodules %}
             {% with module = child %}
-              {% include "module.html" with context %}
+              {% include module|get_template with context %}
             {% endwith %}
 
           {% endif %}

mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html

@@ -21,7 +21,11 @@
               {% endwith %}
             {% endif %}
           </td>
-          <td>{{ attribute.description|convert_markdown(heading_level, html_id) }}</td>
+          <td>
+            <div class="doc-md-description">
+              {{ attribute.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </td>
         </tr>
       {% endfor %}
     </tbody>
@@ -39,7 +43,10 @@
             (<code>{% include "expression.html" with context %}</code>)
           {% endwith %}
         {% endif %}
-        – {{ attribute.description|convert_markdown(heading_level, html_id) }}
+        –
+        <div class="doc-md-description">
+          {{ attribute.description|convert_markdown(heading_level, html_id) }}
+        </div>
       </li>
     {% endfor %}
   </ul>
@@ -58,7 +65,9 @@
         <tr>
           <td><code>{{ attribute.name }}</code></td>
           <td class="doc-attribute-details">
-            {{ attribute.description|convert_markdown(heading_level, html_id) }}
+            <div class="doc-md-description">
+              {{ attribute.description|convert_markdown(heading_level, html_id) }}
+            </div>
             <p>
               {% if attribute.annotation %}
                 <span class="doc-attribute-annotation">

mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html

@@ -21,7 +21,11 @@
               {% endwith %}
             {% endif %}
           </td>
-          <td>{{ parameter.description|convert_markdown(heading_level, html_id) }}</td>
+          <td>
+            <div class="doc-md-description">
+              {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </td>
         </tr>
       {% endfor %}
     </tbody>
@@ -39,7 +43,10 @@
             (<code>{% include "expression.html" with context %}</code>)
           {% endwith %}
         {% endif %}
-        – {{ parameter.description|convert_markdown(heading_level, html_id) }}
+        –
+        <div class="doc-md-description">
+          {{ parameter.description|convert_markdown(heading_level, html_id) }}
+        </div>
       </li>
     {% endfor %}
   </ul>
@@ -58,7 +65,9 @@
         <tr>
           <td><code>{{ parameter.name }}</code></td>
           <td class="doc-param-details">
-            {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            <div class="doc-md-description">
+              {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            </div>
             <p>
               {% if parameter.annotation %}
                 <span class="doc-param-annotation">

mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html

@@ -22,7 +22,11 @@
               {% endwith %}
             {% endif %}
           </td>
-          <td>{{ parameter.description|convert_markdown(heading_level, html_id) }}</td>
+          <td>
+            <div class="doc-md-description">
+              {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </td>
           <td>
             {% if parameter.default %}
               {% with expression = parameter.default %}
@@ -49,7 +53,10 @@
             (<code>{% include "expression.html" with context %}</code>)
           {% endwith %}
         {% endif %}
-        – {{ parameter.description|convert_markdown(heading_level, html_id) }}
+        –
+        <div class="doc-md-description">
+          {{ parameter.description|convert_markdown(heading_level, html_id) }}
+        </div>
       </li>
     {% endfor %}
   </ul>
@@ -68,7 +75,9 @@
         <tr>
           <td><code>{{ parameter.name }}</code></td>
           <td class="doc-param-details">
-            {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            <div class="doc-md-description">
+              {{ parameter.description|convert_markdown(heading_level, html_id) }}
+            </div>
             <p>
               {% if parameter.annotation %}
                 <span class="doc-param-annotation">

mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html

@@ -19,7 +19,11 @@
               {% endwith %}
             {% endif %}
           </td>
-          <td>{{ raises.description|convert_markdown(heading_level, html_id) }}</td>
+          <td>
+            <div class="doc-md-description">
+              {{ raises.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </td>
         </tr>
       {% endfor %}
     </tbody>
@@ -37,7 +41,9 @@
           {% endwith %}
           –
         {% endif %}
-        {{ raises.description|convert_markdown(heading_level, html_id) }}
+        <div class="doc-md-description">
+          {{ raises.description|convert_markdown(heading_level, html_id) }}
+        </div>
       </li>
     {% endfor %}
   </ul>
@@ -62,7 +68,9 @@
             </span>
           </td>
           <td class="doc-raises-details">
-            {{ raises.description|convert_markdown(heading_level, html_id) }}
+            <div class="doc-md-description">
+              {{ raises.description|convert_markdown(heading_level, html_id) }}
+            </div>
           </td>
         </tr>
       {% endfor %}

mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html

@@ -22,7 +22,11 @@
               {% endwith %}
             {% endif %}
           </td>
-          <td>{{ receives.description|convert_markdown(heading_level, html_id) }}</td>
+          <td>
+            <div class="doc-md-description">
+              {{ receives.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </td>
         </tr>
       {% endfor %}
     </tbody>
@@ -42,7 +46,10 @@
             {% if receives.name %}){% endif %}
           {% endwith %}
         {% endif %}
-        – {{ receives.description|convert_markdown(heading_level, html_id) }}
+        –
+        <div class="doc-md-description">
+          {{ receives.description|convert_markdown(heading_level, html_id) }}
+        </div>
       </li>
     {% endfor %}
   </ul>
@@ -71,7 +78,9 @@
             {% endif %}
           </td>
           <td class="doc-receives-details">
-            {{ receives.description|convert_markdown(heading_level, html_id) }}
+            <div class="doc-md-description">
+              {{ receives.description|convert_markdown(heading_level, html_id) }}
+            </div>
             {% if receives.name and receives.annotation %}
               <p>
                 <span class="doc-receives-annotation">

mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html

@@ -22,7 +22,11 @@
               {% endwith %}
             {% endif %}
           </td>
-          <td>{{ returns.description|convert_markdown(heading_level, html_id) }}</td>
+          <td>
+            <div class="doc-md-description">
+              {{ returns.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </td>
         </tr>
       {% endfor %}
     </tbody>
@@ -42,7 +46,10 @@
             {% if returns.name %}){% endif %}
           {% endwith %}
         {% endif %}
-        – {{ returns.description|convert_markdown(heading_level, html_id) }}
+        –
+        <div class="doc-md-description">
+          {{ returns.description|convert_markdown(heading_level, html_id) }}
+      </div>
       </li>
     {% endfor %}
   </ul>
@@ -71,7 +78,9 @@
             {% endif %}
           </td>
           <td class="doc-returns-details">
-            {{ returns.description|convert_markdown(heading_level, html_id) }}
+            <div class="doc-md-description">
+              {{ returns.description|convert_markdown(heading_level, html_id) }}
+            </div>
             {% if returns.name and returns.annotation %}
               <p>
                 <span class="doc-returns-annotation">

mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html

@@ -19,7 +19,11 @@
               {% endwith %}
             {% endif %}
           </td>
-          <td>{{ warns.description|convert_markdown(heading_level, html_id) }}</td>
+          <td>
+            <div class="doc-md-description">
+              {{ warns.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </td>
         </tr>
       {% endfor %}
     </tbody>
@@ -37,7 +41,9 @@
           {% endwith %}
           –
         {% endif %}
-        {{ warns.description|convert_markdown(heading_level, html_id) }}
+        <div class="doc-md-description">
+          {{ warns.description|convert_markdown(heading_level, html_id) }}
+        </div>
       </li>
     {% endfor %}
   </ul>
@@ -62,7 +68,9 @@
             </span>
           </td>
           <td class="doc-warns-details">
-            {{ warns.description|convert_markdown(heading_level, html_id) }}
+            <div class="doc-md-description">
+              {{ warns.description|convert_markdown(heading_level, html_id) }}
+            </div>
           </td>
         </tr>
       {% endfor %}

mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html

@@ -22,7 +22,11 @@
               {% endwith %}
             {% endif %}
           </td>
-          <td>{{ yields.description|convert_markdown(heading_level, html_id) }}</td>
+          <td>
+            <div class="doc-md-description">
+              {{ yields.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </td>
         </tr>
       {% endfor %}
     </tbody>
@@ -42,7 +46,10 @@
             {% if yields.name %}){% endif %}
           {% endwith %}
         {% endif %}
-        – {{ yields.description|convert_markdown(heading_level, html_id) }}
+        –
+        <div class="doc-md-description">
+          {{ yields.description|convert_markdown(heading_level, html_id) }}
+        </div>
       </li>
     {% endfor %}
   </ul>
@@ -71,7 +78,9 @@
             {% endif %}
           </td>
           <td class="doc-yields-details">
-            {{ yields.description|convert_markdown(heading_level, html_id) }}
+            <div class="doc-md-description">
+              {{ yields.description|convert_markdown(heading_level, html_id) }}
+            </div>
             {% if yields.name and yields.annotation %}
               <p>
                 <span class="doc-yields-annotation">

mkdocstrings_handlers/python/templates/material/style.css

@@ -8,10 +8,10 @@ h5.doc-heading {
   word-break: normal !important;
 }
 
-/* For pieces of Markdown rendered in table cells. */
-.doc-contents td p {
-  margin-top: 0 !important;
-  margin-bottom: 0 !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. */
@@ -20,16 +20,12 @@ h5.doc-heading {
   display: table !important;
   width: 100%;
 }
+
 .doc .md-typeset__table tr {
   display: table-row;
 }
 
-/* Avoid line breaks in rendered fields. */
-.field-body p {
-  display: inline;
-}
-
 /* Defaults in Spacy table style. */
 .doc-param-default {
   float: right;
-}
+}

mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html

@@ -0,0 +1,30 @@
+{{ log.debug() }}
+<table class="field-list">
+  <colgroup>
+    <col class="field-name" />
+    <col class="field-body" />
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field">
+      <th class="field-name">{{ section.title or "Attributes:" }}</th>
+      <td class="field-body">
+        <ul class="first simple">
+          {% for attribute in section.value %}
+            <li>
+              <b>{{ attribute.name }}</b>
+              {% if attribute.annotation %}
+                {% with expression = attribute.annotation %}
+                  (<code>{% include "expression.html" with context %}</code>)
+                {% endwith %}
+              {% endif %}
+              –
+              <div class="doc-md-description">
+                {{ attribute.description|convert_markdown(heading_level, html_id) }}
+              </div>
+            </li>
+          {% endfor %}
+        </ul>
+      </td>
+    </tr>
+  </tbody>
+</table>

mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html

@@ -0,0 +1,30 @@
+{{ log.debug() }}
+<table class="field-list">
+  <colgroup>
+    <col class="field-name" />
+    <col class="field-body" />
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field">
+      <th class="field-name">{{ section.title or "Other parameters:" }}</th>
+      <td class="field-body">
+        <ul class="first simple">
+          {% for parameter in section.value %}
+            <li>
+              <b>{{ parameter.name }}</b>
+              {% if parameter.annotation %}
+                {% with expression = parameter.annotation %}
+                  (<code>{% include "expression.html" with context %}</code>)
+                {% endwith %}
+              {% endif %}
+              –
+              <div class="doc-md-description">
+                {{ parameter.description|convert_markdown(heading_level, html_id) }}
+              </div>
+            </li>
+          {% endfor %}
+        </ul>
+      </td>
+    </tr>
+  </tbody>
+</table>

mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html

@@ -0,0 +1,30 @@
+{{ log.debug() }}
+<table class="field-list">
+  <colgroup>
+    <col class="field-name" />
+    <col class="field-body" />
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field">
+      <th class="field-name">{{ section.title or "Parameters:" }}</th>
+      <td class="field-body">
+        <ul class="first simple">
+          {% for parameter in section.value %}
+            <li>
+              <b>{{ parameter.name }}</b>
+              {% if parameter.annotation %}
+                {% with expression = parameter.annotation %}
+                  (<code>{% include "expression.html" with context %}</code>)
+                {% endwith %}
+              {% endif %}
+              –
+              <div class="doc-md-description">
+                {{ parameter.description|convert_markdown(heading_level, html_id) }}
+              </div>
+            </li>
+          {% endfor %}
+        </ul>
+      </td>
+    </tr>
+  </tbody>
+</table>

mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html

@@ -0,0 +1,29 @@
+{{ log.debug() }}
+<table class="field-list">
+  <colgroup>
+    <col class="field-name" />
+    <col class="field-body" />
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field">
+      <th class="field-name">{{ section.title or "Raises:" }}</th>
+      <td class="field-body">
+        <ul class="first simple">
+          {% for raises in section.value %}
+            <li>
+              {% if raises.annotation %}
+                {% with expression = raises.annotation %}
+                  <code>{% include "expression.html" with context %}</code>
+                {% endwith %}
+              {% endif %}
+              –
+              <div class="doc-md-description">
+                {{ raises.description|convert_markdown(heading_level, html_id) }}
+              </div>
+            </li>
+          {% endfor %}
+        </ul>
+      </td>
+    </tr>
+  </tbody>
+</table>

mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html

@@ -0,0 +1,32 @@
+{{ log.debug() }}
+<table class="field-list">
+  <colgroup>
+    <col class="field-name" />
+    <col class="field-body" />
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field">
+      <th class="field-name">{{ section.title or "Receives:" }}</th>
+      <td class="field-body">
+        <ul class="first simple">
+          {% for receives in section.value %}
+            <li>
+              {% if receives.name %}<b>{{ receives.name }}</b>{% endif %}
+              {% if receives.annotation %}
+                {% with expression = receives.annotation %}
+                  {% if receives.name %}({% endif %}
+                  <code>{% include "expression.html" with context %}</code>
+                  {% if receives.name %}){% endif %}
+                {% endwith %}
+              {% endif %}
+              –
+              <div class="doc-md-description">
+                {{ receives.description|convert_markdown(heading_level, html_id) }}
+              </div>
+            </li>
+          {% endfor %}
+        </ul>
+      </td>
+    </tr>
+  </tbody>
+</table>

mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html

@@ -0,0 +1,32 @@
+{{ log.debug() }}
+<table class="field-list">
+  <colgroup>
+    <col class="field-name" />
+    <col class="field-body" />
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field">
+    <th class="field-name">{{ section.title or "Returns:" }}</th>
+    <td class="field-body">
+      <ul class="first simple">
+        {% for returns in section.value %}
+          <li>
+            {% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
+            {% if returns.annotation %}
+              {% with expression = returns.annotation %}
+                {% if returns.name %}({% endif %}
+                <code>{% include "expression.html" with context %}</code>
+                {% if returns.name %}){% endif %}
+              {% endwith %}
+            {% endif %}
+            –
+            <div class="doc-md-description">
+              {{ returns.description|convert_markdown(heading_level, html_id) }}
+            </div>
+          </li>
+        {% endfor %}
+      </ul>
+    </td>
+    </tr>
+  </tbody>
+</table>

mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html

@@ -0,0 +1,29 @@
+{{ log.debug() }}
+<table class="field-list">
+  <colgroup>
+    <col class="field-name" />
+    <col class="field-body" />
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field">
+      <th class="field-name">{{ section.title or "Warns:" }}</th>
+      <td class="field-body">
+        <ul class="first simple">
+          {% for warns in section.value %}
+            <li>
+              {% if warns.annotation %}
+                {% with expression = warns.annotation %}
+                  <code>{% include "expression.html" with context %}</code>
+                {% endwith %}
+              {% endif %}
+              –
+              <div class="doc-md-description">
+                {{ warns.description|convert_markdown(heading_level, html_id) }}
+              </div>
+            </li>
+          {% endfor %}
+        </ul>
+      </td>
+    </tr>
+  </tbody>
+</table>

mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html

@@ -0,0 +1,32 @@
+{{ log.debug() }}
+<table class="field-list">
+  <colgroup>
+    <col class="field-name" />
+    <col class="field-body" />
+  </colgroup>
+  <tbody valign="top">
+    <tr class="field">
+      <th class="field-name">{{ section.title or "Yields:" }}</th>
+      <td class="field-body">
+        <ul class="first simple">
+          {% for yields in section.value %}
+            <li>
+              {% if yields.name %}<b>{{ yields.name }}</b>{% endif %}
+              {% if yields.annotation %}
+                {% with expression = yields.annotation %}
+                  {% if yields.name %}({% endif %}
+                  <code>{% include "expression.html" with context %}</code>
+                  {% if yields.name %}){% endif %}
+                {% endwith %}
+              {% endif %}
+              –
+              <div class="doc-md-description">
+                {{ yields.description|convert_markdown(heading_level, html_id) }}
+              </div>
+            </li>
+          {% endfor %}
+        </ul>
+      </td>
+    </tr>
+  </tbody>
+</table>

mkdocstrings_handlers/python/templates/readthedocs/style.css

@@ -3,10 +3,10 @@
   word-break: normal !important;
 }
 
-/* For pieces of Markdown rendered in table cells. */
-.doc-contents td p {
-  margin-top: 0 !important;
-  margin-bottom: 0 !important;
+/* No line break before first paragraph of descriptions. */
+.doc-md-description,
+.doc-md-description>p:first-child {
+  display: inline;
 }
 
 /* Avoid breaking code headings. */
@@ -18,10 +18,39 @@
 .doc-contents .field-name {
   min-width: 100px;
 }
-.doc-contents .field-name, .field-body {
+
+/* Other curious-spacing fixes. */
+.doc-contents .field-name,
+.doc-contents .field-body {
   border: none !important;
   padding: 0 !important;
 }
+
+.doc-contents p {
+  margin: 1em 0 1em;
+}
+
 .doc-contents .field-list {
   margin: 0 !important;
 }
+
+.doc-contents pre {
+  padding: 0 !important;
+}
+
+.doc-contents .wy-table-responsive {
+  margin-bottom: 0 !important;
+}
+
+.doc-contents td.code {
+  padding: 0 !important;
+}
+
+.doc-contents td.linenos {
+  padding: 0 8px !important;
+}
+
+.doc-children,
+footer {
+  margin-top: 20px;
+}

{mkdocstrings_python-1.0.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.0.0
+Version: 1.1.1
 Summary: A Python handler for mkdocstrings.
 Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
 License: ISC
@@ -25,8 +25,8 @@ Project-URL: Changelog, https://mkdocstrings.github.io/python/changelog
 Project-URL: Repository, https://github.com/mkdocstrings/python
 Project-URL: Issues, https://github.com/mkdocstrings/python/issues
 Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
-Project-URL: Gitter, https://gitter.im/python/community
-Project-URL: Funding, https://github.com/sponsors/mkdocstrings
+Project-URL: Gitter, https://gitter.im/mkdocstrings/python
+Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.7
 Requires-Dist: mkdocstrings>=0.20
 Requires-Dist: griffe>=0.24

{mkdocstrings_python-1.0.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/RECORD

@@ -1,21 +1,21 @@
 mkdocstrings_handlers/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/__init__.py,sha256=CJT3hmg9HpEMy5dbq2jL3Y8unO6UOHND7yCLojwQrS8,326
-mkdocstrings_handlers/python/handler.py,sha256=vX6vRqZRV-nwCFCrjxBUuH0zC1gXwWBHBhgeGHM72Cw,17985
-mkdocstrings_handlers/python/rendering.py,sha256=NMlXtGyE5pQZrdhkwqDnxRLTvc0Kes_T7xGy0-tZiTM,7542
+mkdocstrings_handlers/python/handler.py,sha256=VKDSxsSCFMNsTJSox4VBHLFkqaHk4A7fzUQVli2OxK0,18098
+mkdocstrings_handlers/python/rendering.py,sha256=hjj64VBYJrQlVFF3jxwkla7nG5al6rXl0YH4AsHwPiY,7871
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=JXn5axcd2ssBb02kzs9OVnKvo-UINOIC1ivsGpflIdc,2532
-mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=-FKVAh62bJyqZ3T1R1lgtaRmIsZPnnuAfv-Lov1Hz50,5053
+mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=NOf0LuqOXOg3SVEwwP8ARndWjZrk8q2o-1Ajrrp4dG0,5036
 mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=wtTLXZl8gvOicdfxOCQaFt_59bn754C1k2ILbE4XvlE,4078
 mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=LZu_zGw1YyGHN1fq-loPN9eKyYwC3rDWMyQbh31hD20,1740
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=wiD2FtMnGrFMZJDilURnNqzIu8bOR0zcMErUVUqbDPo,274
-mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html,sha256=NwDp0mIyCnI43glTtFUbU7g0F0QismxyGPa7KV0ia3c,2465
+mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html,sha256=6b9_bsqTOP_Ye_SFhniGL6ikeDoVKRn7g7Mn7QVF9Po,2687
 mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html,sha256=TzN-q73kS2PlLmfkyQUr9YjBdrunKAuO6rYhxyfukyQ,400
-mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html,sha256=O9haz6hgC_s5i1TH5MCN7DVo47Mfz74NF3DvcKLlZoI,2475
-mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html,sha256=Zrwqa1lmktUyDSYWjXLsI21wNztcljx6khTH90LiS9g,3134
-mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html,sha256=HUn7I9ByR5SqIZSDd5_borKZKGVo5kyK8YbsnPYmY3Y,2132
-mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html,sha256=W4OmWPLChpAgQQoxdqZiYO9_3yYaalCIgxgd5rKoI6o,3111
-mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html,sha256=EXaLJoz2vtQWVPAtQt2kbIw8xP3Y001vv9SIZvbZaMk,3081
-mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html,sha256=8J7heEPD8IGNE-lr7mXAezB8RRWZ-YoUUdGnFl9FEpE,2115
-mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=43aDbTwzyGm4xyUf_p1T02MzsSHV_sNny2Se7KvPaqs,3051
+mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html,sha256=CYO8l1n4OOP4mH5cDs9gZMDqF8-daQ9elTfTdU58IbY,2697
+mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html,sha256=DAtSITqkaf0NCtfPTqWNnxLK5ne9mrDkSnIHYq83WSE,3356
+mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html,sha256=TE0xmghh49v9BkbmyjeYiVGmXrJjI64dRIhprHfFLtM,2346
+mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html,sha256=dY40JlN0e2uEVl0qtIiAbRX0sljz7_MWatYCdSNODdc,3333
+mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html,sha256=lN8kdp7PlfITtiB_SefDo_qACw-wQISNpjWkFvmA8RY,3301
+mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html,sha256=DIafhIfSwbMFQ9iiPpC1b0EOXTEBv3gBhZCW3gk9zpo,2329
+mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=2XAhsihe_74sTY5Cc_l_Pji5iYPo70mRxBIInq156jA,3273
 mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=up-Z_v7N7MAmj_UKfR8Xc9TJHnBggIxcQaMXmubzRt8,674
 mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=_3-qihPbyZn9ijyUdJzfHSa1wA9NzCVzMx14Pq404EU,2436
 mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=Y85VylttZ7lYqtCjIjG3UjMaBNHWEiHEmfFMF6nyv6U,245
@@ -40,20 +40,17 @@ mkdocstrings_handlers/python/templates/material/function.html,sha256=SnLKA0qKWts
 mkdocstrings_handlers/python/templates/material/labels.html,sha256=-Jp8tj1BDi7a7f2GfLvyOWulzRBKpOe95JT6QwgfgCQ,34
 mkdocstrings_handlers/python/templates/material/module.html,sha256=GKdbkIxQoObcjxZP6PRLpLOYXMVFS4gSN-nxolEeDjw,34
 mkdocstrings_handlers/python/templates/material/signature.html,sha256=u9zdNsM5Lqh0ROOcThzsjHeHPJCMixy3XfzjypwyGLM,37
-mkdocstrings_handlers/python/templates/material/style.css,sha256=aYoiLDx0S8-eGS0sr1cscRlsCHkr6mBjsN4yZgHYPAU,703
-mkdocstrings_handlers/python/templates/mkdocs/exceptions.html,sha256=V4aZyaHggUpwOyOQtry6fGFqzTysJupiWCRSz3Bl5Og,224
-mkdocstrings_handlers/python/templates/mkdocs/keyword_args.html,sha256=RagEdkW3xwahCDAvYpDgzsxyRXj8h8V706l17DSoY5s,277
-mkdocstrings_handlers/python/templates/mkdocs/parameters.html,sha256=c7YSWlnKrrk2eNn3b6xDTIEKfHGVbvGhNHI6JjrlWTM,293
-mkdocstrings_handlers/python/templates/mkdocs/return.html,sha256=kJNhoMnMHJ1Gcr8i1sLLhvaWZ6MRzoJzh32rNcOIrww,200
-mkdocstrings_handlers/python/templates/mkdocs/style.css,sha256=WGJoK9h0PbiL5h_u1Nj5YoEgjPr3UiwCKAXU7vpLQ70,137
-mkdocstrings_handlers/python/templates/mkdocs/yield.html,sha256=8-1dmOywfphBOdoLBNwu7NdhnVxh7FgCp4klkILS3nU,196
-mkdocstrings_handlers/python/templates/readthedocs/exceptions.html,sha256=LN3Wje6V0yRMpyuqfNknZLnAvB9qf5sGXcduoy7tqy8,545
-mkdocstrings_handlers/python/templates/readthedocs/other_parameters.html,sha256=XrC5NWZfyBazyf0PYGzGPVPUOL_SPxz5XXaGlGbNw9k,601
-mkdocstrings_handlers/python/templates/readthedocs/parameters.html,sha256=c0pfsjfCwDAZCE48Jyp_2geXukJvf-0yvair2RBN4Yg,618
-mkdocstrings_handlers/python/templates/readthedocs/returns.html,sha256=1rvLz7n3xHkhc82mOCJdjgRpGGIFdJqhmiVpv9pdxBE,494
-mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=FNcAj6sgr1H8cg9MCkqlOMoYeM2EWExIRVRCmilL9YY,600
-mkdocstrings_handlers/python/templates/readthedocs/yields.html,sha256=QLl6geeYfOHJ3xwmuRl-rAScei0DtIxFmlSgVO53Hhc,490
-mkdocstrings_python-1.0.0.dist-info/METADATA,sha256=9nEqCr_Ghp0KTGQx6X_HQjnq5nTTpWwf0FgL8Wufv70,5749
-mkdocstrings_python-1.0.0.dist-info/WHEEL,sha256=7dGFtUmOf30dPBLpGD2z643cxg89joO7p3JHBAwDv6E,90
-mkdocstrings_python-1.0.0.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.0.0.dist-info/RECORD,,
+mkdocstrings_handlers/python/templates/material/style.css,sha256=d0A4LjU-pNbb23hyyP8I32B2fFjlZ1ngU2-ukzmwubk,623
+mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html,sha256=setEEw-4Ycb5d6FXxlMXuGIpkEqOwn78JgXX4pF8FBw,928
+mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html,sha256=mX0EE_jil-nvhMpmZeKPAtlV2yqWpezvvLoRZs1SaUA,934
+mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html,sha256=s4jwdD8fzWBaMRXDgFMQoB0tmP7gtzugksQODCNP6rY,928
+mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html,sha256=zCexVPRpZQECSErVQcZPlHp9BQv_0p4LmJi1tFPC3h8,868
+mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html,sha256=Zf4kYW_TBeWcreb6wvb1cOP_cm2_uUpSW3m968VqncA,1058
+mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html,sha256=g54wjwNw_nPG_k9HpEzyC5eRuh-U3vZeZ2gdg5CIpX0,1007
+mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html,sha256=HDKm9LUkW4uYk0YZufzHHz241IlBM897_2KQveIuSQM,863
+mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html,sha256=Wzoi81LqoPZEXU4OWyRgH4LMZIZcnfbrTJKPf3LqHYM,1040
+mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
+mkdocstrings_python-1.1.1.dist-info/METADATA,sha256=m9y6759JzpWIqlwNcfhtfm96zCcW13G7_ouPXeT49gQ,5747
+mkdocstrings_python-1.1.1.dist-info/WHEEL,sha256=m6kf1fJuo48rT4uxh0SeA_FsGq51BpCh_8VNBKVwYQA,90
+mkdocstrings_python-1.1.1.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-1.1.1.dist-info/RECORD,,

{mkdocstrings_python-1.0.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.0.6)
+Generator: pdm-backend (2.0.7)
 Root-Is-Purelib: true
 Tag: py3-none-any

mkdocstrings_handlers/python/templates/mkdocs/exceptions.html

@@ -1,7 +0,0 @@
-{{ log.debug() }}
-<dl>
-  <dt>Exceptions:</dt>
-  {% for exception in exceptions %}
-    <dd>{{ ("`" + exception.annotation + "`: " + exception.description)|convert_markdown(heading_level, html_id) }}</dd>
-  {% endfor %}
-</dl>

mkdocstrings_handlers/python/templates/mkdocs/keyword_args.html

@@ -1,7 +0,0 @@
-{{ log.debug() }}
-<dl>
-  <dt>Keyword arguments:</dt>
-  {% for kwarg in kwargs %}
-    <dd>{{ ("**" + kwarg.name + ":** " + ("`" + kwarg.annotation + "` – " if kwarg.annotation else "") + kwarg.description)|convert_markdown(heading_level, html_id) }}</dd>
-  {% endfor %}
-</dl>

mkdocstrings_handlers/python/templates/mkdocs/parameters.html

@@ -1,7 +0,0 @@
-{{ log.debug() }}
-<dl>
-  <dt>Arguments:</dt>
-  {% for parameter in parameters %}
-    <dd>{{ ("**" + parameter.name + ":** " + ("`" + parameter.annotation + "` – " if parameter.annotation else "") + parameter.description)|convert_markdown(heading_level, html_id) }}</dd>
-  {% endfor %}
-</dl>

mkdocstrings_handlers/python/templates/mkdocs/return.html

@@ -1,5 +0,0 @@
-{{ log.debug() }}
-<dl>
-    <dt>Returns:</dt>
-    <dd>{{ (("`" + return.annotation + "` – " if return.annotation else "") + return.description)|convert_markdown(heading_level, html_id) }}</dd>
-</dl>

mkdocstrings_handlers/python/templates/mkdocs/style.css

@@ -1,11 +0,0 @@
-.doc-contents {
-  padding-left: 20px;
-}
-
-.doc-contents dd>p {
-  margin-bottom: 0.5rem;
-}
-
-.doc-contents dl+dl {
-  margin-top: -0.5rem;
-}

mkdocstrings_handlers/python/templates/mkdocs/yield.html

@@ -1,5 +0,0 @@
-{{ log.debug() }}
-<dl>
-    <dt>Yields:</dt>
-    <dd>{{ (("`" + yield.annotation + "` – " if yield.annotation else "") + yield.description)|convert_markdown(heading_level, html_id) }}</dd>
-</dl>

mkdocstrings_handlers/python/templates/readthedocs/exceptions.html

@@ -1,19 +0,0 @@
-{{ log.debug() }}
-<table class="field-list">
-  <colgroup>
-    <col class="field-name" />
-    <col class="field-body" />
-  </colgroup>
-  <tbody valign="top">
-    <tr class="field">
-      <th class="field-name">Exceptions:</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for exception in exceptions %}
-            <li>{{ ("`" + exception.annotation + "` – " + exception.description)|convert_markdown(heading_level, html_id) }}</li>
-          {% endfor %}
-        </ul>
-      </td>
-    </tr>
-  </tbody>
-</table>

mkdocstrings_handlers/python/templates/readthedocs/other_parameters.html

@@ -1,19 +0,0 @@
-{{ log.debug() }}
-<table class="field-list">
-  <colgroup>
-    <col class="field-name" />
-    <col class="field-body" />
-  </colgroup>
-  <tbody valign="top">
-    <tr class="field">
-      <th class="field-name">Keyword arguments:</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for kwarg in kwargs %}
-            <li>{{ ("**" + kwarg.name + "**" + (" (`" + kwarg.annotation + "`)" if kwarg.annotation else "") + " – " + kwarg.description)|convert_markdown(heading_level, html_id) }}</li>
-          {% endfor %}
-        </ul>
-      </td>
-    </tr>
-  </tbody>
-</table>

mkdocstrings_handlers/python/templates/readthedocs/parameters.html

@@ -1,19 +0,0 @@
-{{ log.debug() }}
-<table class="field-list">
-  <colgroup>
-    <col class="field-name" />
-    <col class="field-body" />
-  </colgroup>
-  <tbody valign="top">
-    <tr class="field">
-      <th class="field-name">Parameters:</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for parameter in parameters %}
-            <li>{{ ("**" + parameter.name + "**" + (" (`" + parameter.annotation + "`)" if parameter.annotation else "") + " – " + parameter.description)|convert_markdown(heading_level, html_id) }}</li>
-          {% endfor %}
-        </ul>
-      </td>
-    </tr>
-  </tbody>
-</table>

mkdocstrings_handlers/python/templates/readthedocs/returns.html

@@ -1,17 +0,0 @@
-{{ log.debug() }}
-<table class="field-list">
-  <colgroup>
-    <col class="field-name" />
-    <col class="field-body" />
-  </colgroup>
-  <tbody valign="top">
-    <tr class="field">
-    <th class="field-name">Returns:</th>
-    <td class="field-body">
-        <ul class="first simple">
-          <li>{{ ((("`" + return.annotation + "` – ") if return.annotation else "") + return.description)|convert_markdown(heading_level, html_id) }}</li>
-        </ul>
-    </td>
-    </tr>
-  </tbody>
-</table>

mkdocstrings_handlers/python/templates/readthedocs/yields.html

@@ -1,17 +0,0 @@
-{{ log.debug() }}
-<table class="field-list">
-  <colgroup>
-    <col class="field-name" />
-    <col class="field-body" />
-  </colgroup>
-  <tbody valign="top">
-    <tr class="field">
-    <th class="field-name">Yields:</th>
-    <td class="field-body">
-        <ul class="first simple">
-          <li>{{ ((("`" + yield.annotation + "` – ") if yield.annotation else "") + yield.description)|convert_markdown(heading_level, html_id) }}</li>
-        </ul>
-    </td>
-    </tr>
-  </tbody>
-</table>