refactor: Update *.html top-level templates to extend the *.html.jinja base templates

pawamoy · pawamoy · commit a8c540e95693 · 2024-04-28T16:21:43.000+02:00
Issue-151: #151
diff --git a/src/mkdocstrings_handlers/python/templates/material/attribute.html b/src/mkdocstrings_handlers/python/templates/material/attribute.html
@@ -1 +1 @@
-{% extends "_base/attribute.html" %}
+{% extends "_base/attribute.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/children.html b/src/mkdocstrings_handlers/python/templates/material/children.html
@@ -1 +1 @@
-{% extends "_base/children.html" %}
+{% extends "_base/children.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/class.html b/src/mkdocstrings_handlers/python/templates/material/class.html
@@ -1 +1 @@
-{% extends "_base/class.html" %}
+{% extends "_base/class.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring.html b/src/mkdocstrings_handlers/python/templates/material/docstring.html
@@ -1 +1 @@
-{% extends "_base/docstring.html" %}
+{% extends "_base/docstring.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html b/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html
@@ -1 +1 @@
-{% extends "_base/docstring/admonition.html" %}
+{% extends "_base/docstring/admonition.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html b/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html
@@ -1 +1 @@
-{% extends "_base/docstring/attributes.html" %}
+{% extends "_base/docstring/attributes.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/classes.html b/src/mkdocstrings_handlers/python/templates/material/docstring/classes.html
@@ -1 +1 @@
-{% extends "_base/docstring/classes.html" %}
+{% extends "_base/docstring/classes.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html b/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html
@@ -1 +1 @@
-{% extends "_base/docstring/examples.html" %}
+{% extends "_base/docstring/examples.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/functions.html b/src/mkdocstrings_handlers/python/templates/material/docstring/functions.html
@@ -1 +1 @@
-{% extends "_base/docstring/functions.html" %}
+{% extends "_base/docstring/functions.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/modules.html b/src/mkdocstrings_handlers/python/templates/material/docstring/modules.html
@@ -1 +1 @@
-{% extends "_base/docstring/modules.html" %}
+{% extends "_base/docstring/modules.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html b/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html
@@ -1 +1 @@
-{% extends "_base/docstring/other_parameters.html" %}
+{% extends "_base/docstring/other_parameters.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html b/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html
@@ -1 +1 @@
-{% extends "_base/docstring/parameters.html" %}
+{% extends "_base/docstring/parameters.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html b/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html
@@ -1 +1 @@
-{% extends "_base/docstring/raises.html" %}
+{% extends "_base/docstring/raises.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html b/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html
@@ -1 +1 @@
-{% extends "_base/docstring/receives.html" %}
+{% extends "_base/docstring/receives.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html b/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html
@@ -1 +1 @@
-{% extends "_base/docstring/returns.html" %}
+{% extends "_base/docstring/returns.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html b/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html
@@ -1 +1 @@
-{% extends "_base/docstring/warns.html" %}
+{% extends "_base/docstring/warns.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html b/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html
@@ -1 +1 @@
-{% extends "_base/docstring/yields.html" %}
+{% extends "_base/docstring/yields.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/expression.html b/src/mkdocstrings_handlers/python/templates/material/expression.html
@@ -1 +1 @@
-{% extends "_base/expression.html" %}
+{% extends "_base/expression.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/function.html b/src/mkdocstrings_handlers/python/templates/material/function.html
@@ -1 +1 @@
-{% extends "_base/function.html" %}
+{% extends "_base/function.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/labels.html b/src/mkdocstrings_handlers/python/templates/material/labels.html
@@ -1 +1 @@
-{% extends "_base/labels.html" %}
+{% extends "_base/labels.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/language.html b/src/mkdocstrings_handlers/python/templates/material/language.html
@@ -1,10 +1 @@
-<!-- Import translations for given language and fallback -->
-{% set lang_pth = "languages/" ~ locale ~ ".html" %}
-{% if lang_pth is existing_template %}
-    {% import lang_pth as lang %}
-    {% import "languages/en.html" as fallback %}
-    {% macro t(key) %}{{ lang.t(key) or fallback.t(key) }}{% endmacro %}
-{% else %}
-    {% import "languages/en.html" as lang %}
-    {% macro t(key) %}{{ lang.t(key) }}{% endmacro %}
-{% endif %}
+{% extends "_base/language.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/languages/en.html b/src/mkdocstrings_handlers/python/templates/material/languages/en.html
@@ -1 +1 @@
-{% extends "_base/languages/en.html" %}
+{% extends "_base/languages/en.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/languages/ja.html b/src/mkdocstrings_handlers/python/templates/material/languages/ja.html
@@ -1 +1 @@
-{% extends "_base/languages/ja.html" %}
+{% extends "_base/languages/ja.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/languages/zh.html b/src/mkdocstrings_handlers/python/templates/material/languages/zh.html
@@ -1 +1 @@
-{% extends "_base/languages/zh.html" %}
+{% extends "_base/languages/zh.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/module.html b/src/mkdocstrings_handlers/python/templates/material/module.html
@@ -1 +1 @@
-{% extends "_base/module.html" %}
+{% extends "_base/module.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/signature.html b/src/mkdocstrings_handlers/python/templates/material/signature.html
@@ -1 +1 @@
-{% extends "_base/signature.html" %}
+{% extends "_base/signature.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/summary.html b/src/mkdocstrings_handlers/python/templates/material/summary.html
@@ -1 +1 @@
-{% extends "_base/summary.html" %}
+{% extends "_base/summary.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/summary/attributes.html b/src/mkdocstrings_handlers/python/templates/material/summary/attributes.html
@@ -1 +1 @@
-{% extends "_base/summary/attributes.html" %}
+{% extends "_base/summary/attributes.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/summary/classes.html b/src/mkdocstrings_handlers/python/templates/material/summary/classes.html
@@ -1 +1 @@
-{% extends "_base/summary/classes.html" %}
+{% extends "_base/summary/classes.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/summary/functions.html b/src/mkdocstrings_handlers/python/templates/material/summary/functions.html
@@ -1 +1 @@
-{% extends "_base/summary/functions.html" %}
+{% extends "_base/summary/functions.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/material/summary/modules.html b/src/mkdocstrings_handlers/python/templates/material/summary/modules.html
@@ -1 +1 @@
-{% extends "_base/summary/modules.html" %}
+{% extends "_base/summary/modules.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html
@@ -1,33 +1 @@
-{{ log.debug() }}
-
-{% import "language.html" as lang with context %}
-
-<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 lang.t("Attributes:") }}</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for attribute in section.value %}
-            <li>
-              <b><code>{{ attribute.name }}</code></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>
+{% extends "_base/docstring/attributes.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html
@@ -1,33 +1 @@
-{{ log.debug() }}
-
-{% import "language.html" as lang with context %}
-
-<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 lang.t("Other parameters:") }}</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for parameter in section.value %}
-            <li>
-              <b><code>{{ parameter.name }}</code></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>
+{% extends "_base/docstring/other_parameters.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html
@@ -1,38 +1 @@
-{{ log.debug() }}
-
-{% import "language.html" as lang with context %}
-
-<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 lang.t("Parameters:") }}</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for parameter in section.value %}
-            <li>
-              <b><code>{{ parameter.name }}</code></b>
-              {% if parameter.annotation %}
-                {% with expression = parameter.annotation %}
-                  (<code>{% include "expression.html" with context %}</code>
-                  {%- if parameter.default %}, {{ lang.t("default:") }}
-                    {% with expression = parameter.default %}
-                      <code>{% include "expression.html" with context %}</code>
-                    {% endwith %}
-                  {% endif %})
-                {% endwith %}
-              {% endif %}
-              –
-              <div class="doc-md-description">
-                {{ parameter.description|convert_markdown(heading_level, html_id) }}
-              </div>
-            </li>
-          {% endfor %}
-        </ul>
-      </td>
-    </tr>
-  </tbody>
-</table>
+{% extends "_base/docstring/parameters.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html
@@ -1,32 +1 @@
-{{ log.debug() }}
-
-{% import "language.html" as lang with context %}
-
-<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 lang.t("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>
+{% extends "_base/docstring/raises.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html
@@ -1,35 +1 @@
-{{ log.debug() }}
-
-{% import "language.html" as lang with context %}
-
-<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 lang.t("Receives:") }}</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for receives in section.value %}
-            <li>
-              {% if receives.name %}<b><code>{{ receives.name }}</code></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>
+{% extends "_base/docstring/receives.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html
@@ -1,35 +1 @@
-{{ log.debug() }}
-
-{% import "language.html" as lang with context %}
-
-<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 lang.t("Returns:") }}</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for returns in section.value %}
-            <li>
-              {% if returns.name %}<b><code>{{ returns.name }}</code></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>
+{% extends "_base/docstring/returns.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html
@@ -1,32 +1 @@
-{{ log.debug() }}
-
-{% import "language.html" as lang with context %}
-
-<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 lang.t("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>
+{% extends "_base/docstring/warns.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html b/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html
@@ -1,35 +1 @@
-{{ log.debug() }}
-
-{% import "language.html" as lang with context %}
-
-<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 lang.t("Yields:") }}</th>
-      <td class="field-body">
-        <ul class="first simple">
-          {% for yields in section.value %}
-            <li>
-              {% if yields.name %}<b></code>{{ yields.name }}</code></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>
+{% extends "_base/docstring/yields.html.jinja" %}
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/language.html b/src/mkdocstrings_handlers/python/templates/readthedocs/language.html
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html b/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html b/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html
diff --git a/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html b/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/attribute.html" %}`
	`1`	`+{% extends "_base/attribute.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/children.html" %}`
	`1`	`+{% extends "_base/children.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/class.html" %}`
	`1`	`+{% extends "_base/class.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/docstring.html" %}`
	`1`	`+{% extends "_base/docstring.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/docstring/admonition.html" %}`
	`1`	`+{% extends "_base/docstring/admonition.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/docstring/attributes.html" %}`
	`1`	`+{% extends "_base/docstring/attributes.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/docstring/classes.html" %}`
	`1`	`+{% extends "_base/docstring/classes.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/docstring/examples.html" %}`
	`1`	`+{% extends "_base/docstring/examples.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/docstring/functions.html" %}`
	`1`	`+{% extends "_base/docstring/functions.html.jinja" %}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-{% extends "_base/docstring/modules.html" %}`
	`1`	`+{% extends "_base/docstring/modules.html.jinja" %}`