mkdocstrings-python 1.18.2__py3-none-any.whl → 2.0.0__py3-none-any.whl

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

@@ -15,8 +15,7 @@ Context:
   {{ log.debug("Rendering yields section") }}
 {% endblock logs %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% 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" %}
@@ -39,8 +38,7 @@ Context:
             <td>
               {% if yields.annotation %}
                 {% with expression = yields.annotation, backlink_type = "yielded-by" %}
-                  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                  <code>{% include "expression"|get_template with context %}</code>
+                  <code>{% include "expression.html.jinja" with context %}</code>
                 {% endwith %}
               {% endif %}
             </td>
@@ -65,8 +63,7 @@ Context:
           {% if yields.annotation %}
             {% with expression = yields.annotation, backlink_type = "yielded-by" %}
               {% if yields.name %} ({% endif %}
-              {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-              <code>{% include "expression"|get_template with context %}</code>
+              <code>{% include "expression.html.jinja" with context %}</code>
               {% if yields.name %}){% endif %}
             {% endwith %}
           {% endif %}
@@ -97,8 +94,7 @@ Context:
               {% elif yields.annotation %}
                 <span class="doc-yields-annotation">
                   {% with expression = yields.annotation, backlink_type = "yielded-by" %}
-                    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                    <code>{% include "expression"|get_template with context %}</code>
+                    <code>{% include "expression.html.jinja" with context %}</code>
                   {% endwith %}
                 </span>
               {% endif %}
@@ -112,8 +108,7 @@ Context:
                   <span class="doc-yields-annotation">
                     <b>{{ lang.t("TYPE:") }}:</b>
                     {% with expression = yields.annotation, backlink_type = "yielded-by" %}
-                      {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-                      <code>{% include "expression"|get_template with context %}</code>
+                      <code>{% include "expression.html.jinja" with context %}</code>
                     {% endwith %}
                   </span>
                 </p>

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

@@ -24,50 +24,35 @@ Context:
       {% if config.show_docstring_description and section.kind.value == "text" %}
         {{ section.value|convert_markdown(heading_level, html_id, autoref_hook=autoref_hook) }}
       {% elif config.show_docstring_attributes and section.kind.value == "attributes" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/attributes"|get_template with context %}
+        {% include "docstring/attributes.html.jinja" with context %}
       {% elif config.show_docstring_functions and section.kind.value == "functions" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/functions"|get_template with context %}
+        {% include "docstring/functions.html.jinja" with context %}
       {% elif config.show_docstring_classes and section.kind.value == "classes" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/classes"|get_template with context %}
+        {% include "docstring/classes.html.jinja" with context %}
       {% elif config.show_docstring_type_aliases and section.kind.value == "type aliases" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/type_aliases"|get_template with context %}
+        {% include "docstring/type_aliases.html.jinja" with context %}
       {% elif config.show_docstring_modules and section.kind.value == "modules" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/modules"|get_template with context %}
+        {% include "docstring/modules.html.jinja" with context %}
       {% elif config.show_docstring_type_parameters and section.kind.value == "type parameters" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/type_parameters"|get_template with context %}
+        {% include "docstring/type_parameters.html.jinja" with context %}
       {% elif config.show_docstring_parameters and section.kind.value == "parameters" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/parameters"|get_template with context %}
+        {% include "docstring/parameters.html.jinja" with context %}
       {% elif config.show_docstring_other_parameters and section.kind.value == "other parameters" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/other_parameters"|get_template with context %}
+        {% include "docstring/other_parameters.html.jinja" with context %}
       {% elif config.show_docstring_raises and section.kind.value == "raises" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/raises"|get_template with context %}
+        {% include "docstring/raises.html.jinja" with context %}
       {% elif config.show_docstring_warns and section.kind.value == "warns" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/warns"|get_template with context %}
+        {% include "docstring/warns.html.jinja" with context %}
       {% elif config.show_docstring_yields and section.kind.value == "yields" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/yields"|get_template with context %}
+        {% include "docstring/yields.html.jinja" with context %}
       {% elif config.show_docstring_receives and section.kind.value == "receives" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/receives"|get_template with context %}
+        {% include "docstring/receives.html.jinja" with context %}
       {% elif config.show_docstring_returns and section.kind.value == "returns" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/returns"|get_template with context %}
+        {% include "docstring/returns.html.jinja" with context %}
       {% elif config.show_docstring_examples and section.kind.value == "examples" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/examples"|get_template with context %}
+        {% include "docstring/examples.html.jinja" with context %}
       {% elif config.show_docstring_description and section.kind.value == "admonition" %}
-        {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-        {% include "docstring/admonition"|get_template with context %}
+        {% include "docstring/admonition.html.jinja" with context %}
       {% endif %}
     {% endfor %}
   {% endwith %}

mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja

@@ -166,4 +166,7 @@ Context:
   {%- endif -%}
 {%- endmacro -%}
 
+{%- if config.modernize_annotations and expression is not string -%}
+  {%- set expression = expression.modernize() -%}
+{%- endif -%}
 {{ render(expression, config.annotations_path, backlink_type|default("")) }}

mkdocstrings_handlers/python/templates/material/_base/function.html.jinja

@@ -17,8 +17,7 @@ Context:
   {{ log.debug("Rendering " + function.path) }}
 {% endblock logs %}
 
-{# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-{% import "language"|get_template as lang with context %}
+{% import "language.html.jinja" as lang with context %}
 {#- Language module providing the `t` translation method. -#}
 
 <div class="doc doc-object doc-function">
@@ -62,9 +61,8 @@ Context:
           {% else %}
             {%+ filter highlight(language="python", inline=True) -%}
               {{ function_name }}
-              {#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within block. -#}
-              {%- include "type_parameters"|get_template with context -%}
-              {%- include "signature"|get_template with context -%}
+              {%- include "type_parameters.html.jinja" with context -%}
+              {%- include "signature.html.jinja" with context -%}
             {%- endfilter %}
           {% endif %}
         {% endblock heading %}
@@ -75,8 +73,7 @@ Context:
           This block renders the labels for the function.
           -#}
           {% with labels = function.labels %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "labels"|get_template with context %}
+            {% include "labels.html.jinja" with context %}
           {% endwith %}
         {% endblock labels %}
 
@@ -134,8 +131,7 @@ Context:
           This block renders the docstring for the function.
           -#}
           {% with docstring_sections = function.docstring.parsed %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "docstring"|get_template with context %}
+            {% include "docstring.html.jinja" with context %}
           {% endwith %}
         {% endblock docstring %}
 
@@ -149,7 +145,7 @@ Context:
           This block renders the source code for the function.
           -#}
           {% if config.show_source and function.source %}
-            <details class="quote">
+            <details class="mkdocstrings-source">
               <summary>{{ lang.t("Source code in") }} <code>
                 {%- if function.relative_filepath.is_absolute() -%}
                   {{ function.relative_package_filepath }}

mkdocstrings_handlers/python/templates/material/_base/language.html.jinja

@@ -7,15 +7,12 @@
   -#}
 {% endblock logs %}
 
-{# YORE: Bump 2: Replace `| get_template` with `~ ".html.jinja"` within line. #}
-{% set lang_pth = "languages/" ~ locale | get_template %}
+{% set lang_pth = "languages/" ~ locale ~ ".html.jinja" %}
 {% if lang_pth is existing_template %}
   {% import lang_pth as lang %}
-  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-  {% import "languages/en"|get_template as fallback %}
+  {% import "languages/en.html.jinja" as fallback %}
   {% macro t(key) %}{{ lang.t(key) or fallback.t(key) }}{% endmacro %}
 {% else %}
-  {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-  {% import "languages/en"|get_template as lang %}
+  {% import "languages/en.html.jinja" as lang %}
   {% macro t(key) %}{{ lang.t(key) }}{% endmacro %}
 {% endif %}

mkdocstrings_handlers/python/templates/material/_base/module.html.jinja

@@ -63,8 +63,7 @@ Context:
           This block renders the labels for the module.
           -#}
           {% with labels = module.labels %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "labels"|get_template with context %}
+            {% include "labels.html.jinja" with context %}
           {% endwith %}
         {% endblock labels %}
 
@@ -98,8 +97,7 @@ Context:
           This block renders the docstring for the module.
           -#}
           {% with docstring_sections = module.docstring.parsed %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "docstring"|get_template with context %}
+            {% include "docstring.html.jinja" with context %}
           {% endwith %}
         {% endblock docstring %}
 
@@ -112,8 +110,7 @@ Context:
 
           This block renders auto-summaries for classes, methods, and attributes.
           -#}
-          {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-          {% include "summary"|get_template with context %}
+          {% include "summary.html.jinja" with context %}
         {% endblock summary %}
 
         {% block children scoped %}
@@ -123,8 +120,7 @@ Context:
           -#}
           {% set root = False %}
           {% set heading_level = heading_level + 1 %}
-          {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-          {% include "children"|get_template with context %}
+          {% include "children.html.jinja" with context %}
         {% endblock children %}
       {% endblock contents %}
     </div>

mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja

@@ -50,8 +50,7 @@ Context:
           {%- if config.separate_signature -%}
             {%- with expression = parameter.annotation -%}
               {%- set ns.annotation -%}: {% with backlink_type = "used-by" -%}
-                {#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. -#}
-                {%- include "expression"|get_template with context -%}
+                {%- include "expression.html.jinja" with context -%}
               {%- endwith -%}{%- endset -%}
             {%- endwith -%}
           {%- else -%}
@@ -106,8 +105,7 @@ Context:
           {{ ns.equal }}
           {%- if config.signature_crossrefs and config.separate_signature -%}
             {%- with expression = parameter.default, backlink_type = "used-by" -%}
-              {#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. -#}
-              {%- include "expression"|get_template with context -%}
+              {%- include "expression.html.jinja" with context -%}
             {%- endwith -%}
           {%- else -%}
             {{ parameter.default|safe }}
@@ -126,8 +124,7 @@ Context:
         and not (config.merge_init_into_class and function.name == "__init__" )
       %} -> {% if config.separate_signature and config.signature_crossrefs -%}
         {%- with expression = function.annotation, backlink_type = "returned-by" -%}
-          {#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. -#}
-          {%- include "expression"|get_template with context -%}
+          {%- include "expression.html.jinja" with context -%}
         {%- endwith -%}
       {%- else -%}
         {{ function.annotation|safe }}

mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja

@@ -18,7 +18,6 @@
       |order_members(config.members_order, members_list)
       |as_attributes_section(check_public=not members_list)
     %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% if section %}{% include "docstring/attributes"|get_template with context %}{% endif %}
+    {% if section %}{% include "docstring/attributes.html.jinja" with context %}{% endif %}
   {% endwith %}
 {% endif %}

mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja

@@ -18,7 +18,6 @@
       |order_members(config.members_order, members_list)
       |as_classes_section(check_public=not members_list)
     %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% if section %}{% include "docstring/classes"|get_template with context %}{% endif %}
+    {% if section %}{% include "docstring/classes.html.jinja" with context %}{% endif %}
   {% endwith %}
 {% endif %}

mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja

@@ -18,7 +18,6 @@
       |order_members(config.members_order, members_list)
       |as_functions_section(check_public=not members_list)
     %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% if section %}{% include "docstring/functions"|get_template with context %}{% endif %}
+    {% if section %}{% include "docstring/functions.html.jinja" with context %}{% endif %}
   {% endwith %}
 {% endif %}

mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja

@@ -18,7 +18,6 @@
       |order_members("alphabetical", members_list)
       |as_modules_section(check_public=not members_list)
     %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% if section %}{% include "docstring/modules"|get_template with context %}{% endif %}
+    {% if section %}{% include "docstring/modules.html.jinja" with context %}{% endif %}
   {% endwith %}
 {% endif %}

mkdocstrings_handlers/python/templates/material/_base/summary/type_aliases.html.jinja

@@ -18,7 +18,6 @@
       |order_members("alphabetical", members_list)
       |as_type_aliases_section(check_public=not members_list)
     %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% if section %}{% include "docstring/type_aliases"|get_template with context %}{% endif %}
+    {% if section %}{% include "docstring/type_aliases.html.jinja" with context %}{% endif %}
   {% endwith %}
 {% endif %}

mkdocstrings_handlers/python/templates/material/_base/summary.html.jinja

@@ -9,27 +9,22 @@
 
 {% with members_list = config.members if root_members else None %}
   {% if config.summary.modules %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% include "summary/modules"|get_template with context %}
+    {% include "summary/modules.html.jinja" with context %}
   {% endif %}
 
   {% if config.summary.type_aliases %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% include "summary/type_aliases"|get_template with context %}
+    {% include "summary/type_aliases.html.jinja" with context %}
   {% endif %}
 
   {% if config.summary.classes %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% include "summary/classes"|get_template with context %}
+    {% include "summary/classes.html.jinja" with context %}
   {% endif %}
 
   {% if config.summary.functions %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% include "summary/functions"|get_template with context %}
+    {% include "summary/functions.html.jinja" with context %}
   {% endif %}
 
   {% if config.summary.attributes %}
-    {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-    {% include "summary/attributes"|get_template with context %}
+    {% include "summary/attributes.html.jinja" with context %}
   {% endif %}
 {% endwith %}

mkdocstrings_handlers/python/templates/material/_base/type_alias.html.jinja

@@ -51,8 +51,7 @@ Context:
             <span class="doc doc-object-name doc-type_alias-name">{{ type_alias_name }}</span>
           {% else %}
             {%+ filter highlight(language="python", inline=True) %}
-              {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-              {{ type_alias_name }}{% include "type_parameters"|get_template with context %} = {{ type_alias.value }}
+              {{ type_alias_name }}{% include "type_parameters.html.jinja" with context %} = {{ type_alias.value }}
             {% endfilter %}
           {% endif %}
         {% endblock heading %}
@@ -63,8 +62,7 @@ Context:
           This block renders the labels for the type alias.
           -#}
           {% with labels = type_alias.labels %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "labels"|get_template with context %}
+            {% include "labels.html.jinja" with context %}
           {% endwith %}
         {% endblock labels %}
 
@@ -109,8 +107,7 @@ Context:
           This block renders the docstring for the type alias.
           -#}
           {% with docstring_sections = type_alias.docstring.parsed %}
-            {# YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. #}
-            {% include "docstring"|get_template with context %}
+            {% include "docstring.html.jinja" with context %}
           {% endwith %}
         {% endblock docstring %}
       {% endblock contents %}

mkdocstrings_handlers/python/templates/material/_base/type_parameters.html.jinja

@@ -27,8 +27,7 @@ Context:
           {%- set ns.equal = " = " -%}
           {%- if config.separate_signature and config.signature_crossrefs -%}
             {%- with expression = type_parameter.annotation -%}
-              {#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. -#}
-              {%- set ns.annotation -%}: {% include "expression"|get_template with context %}{%- endset -%}
+              {%- set ns.annotation -%}: {% include "expression.html.jinja" with context %}{%- endset -%}
             {%- endwith -%}
           {%- else -%}
             {%- set ns.annotation = ": " + type_parameter.annotation|safe -%}
@@ -72,8 +71,7 @@ Context:
           {{ ns.equal }}
           {%- if config.signature_crossrefs and config.separate_signature -%}
             {%- with expression = type_parameter.default -%}
-              {#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. -#}
-              {%- include "expression"|get_template with context -%}
+              {%- include "expression.html.jinja" with context -%}
             {%- endwith -%}
           {%- else -%}
             {{ type_parameter.default|safe }}

mkdocstrings_handlers/python/templates/material/style.css

@@ -210,3 +210,27 @@ code.doc-symbol-module::after {
   color: inherit;
   border-bottom: 1px dotted currentcolor;
 }
+
+/* Source code blocks (admonitions). */
+:root {
+  --md-admonition-icon--mkdocstrings-source: url('data:image/svg+xml;charset=utf-8,<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M15.22 4.97a.75.75 0 0 1 1.06 0l6.5 6.5a.75.75 0 0 1 0 1.06l-6.5 6.5a.749.749 0 0 1-1.275-.326.75.75 0 0 1 .215-.734L21.19 12l-5.97-5.97a.75.75 0 0 1 0-1.06m-6.44 0a.75.75 0 0 1 0 1.06L2.81 12l5.97 5.97a.749.749 0 0 1-.326 1.275.75.75 0 0 1-.734-.215l-6.5-6.5a.75.75 0 0 1 0-1.06l6.5-6.5a.75.75 0 0 1 1.06 0"/></svg>')
+}
+.md-typeset .admonition.mkdocstrings-source,
+.md-typeset details.mkdocstrings-source {
+  border: none;
+  padding: 0;
+}
+.md-typeset .admonition.mkdocstrings-source:focus-within,
+.md-typeset details.mkdocstrings-source:focus-within {
+  box-shadow: none;
+}
+.md-typeset .mkdocstrings-source > .admonition-title,
+.md-typeset .mkdocstrings-source > summary {
+  background-color: inherit;
+}
+.md-typeset .mkdocstrings-source > .admonition-title::before,
+.md-typeset .mkdocstrings-source > summary::before {
+  background-color: var(--md-default-fg-color);
+  -webkit-mask-image: var(--md-admonition-icon--mkdocstrings-source);
+          mask-image: var(--md-admonition-icon--mkdocstrings-source);
+}

mkdocstrings_handlers/python/templates/readthedocs/_base/class.html

@@ -0,0 +1,11 @@
+{% extends "_base/class.html.jinja" %}
+
+{% block logs scoped %}
+  {{ super() }}
+  {# TODO: Switch to a warning after some time. #}
+  {{ log.info(
+        "DeprecationWarning: Extending '_base/class.html' is deprecated, extend '_base/class.html.jinja' instead. " ~
+        "After some time, this message will be logged as a warning, causing strict builds to fail.",
+        once=True,
+      ) }}
+{% endblock logs %}