feat: Suffix templates with jinja extension, add templates for enum, enum member, class and constructor

Issue-3: #3
Issue-4: #4

Author: pawamoy

src/mkdocstrings_handlers/typescript/handler.py

@@ -146,7 +146,7 @@ def render(self, data: CollectorItem, config: Mapping[str, Any]) -> str:
         """
         final_config = {**self.default_config, **config}
         heading_level = final_config["heading_level"]
-        template = self.env.get_template("module.html")
+        template = self.env.get_template("module.html.jinja")
         return template.render(
             config=final_config,
             module=data,

…t/templates/material/_base/children.html …lates/material/_base/children.html.jinjasrc/mkdocstrings_handlers/typescript/templates/material/_base/children.html renamed to src/mkdocstrings_handlers/typescript/templates/material/_base/children.html.jinja src/mkdocstrings_handlers/typescript/templates/material/_base/children.html renamed to src/mkdocstrings_handlers/typescript/templates/material/_base/children.html.jinja

@@ -4,7 +4,7 @@
       {{ log.debug("Rendering children of " + obj.path) }}
       <div class="doc doc-children">
         {% for obj in children %}
-          {% include "dispatch.html" with context %}
+          {% include "dispatch.html.jinja" with context %}
         {% endfor %}
       </div>
     {% endif %}
@@ -15,15 +15,15 @@
     {% for group in obj.resolved_groups %}
       <b>{{ group.title }}</b>
       {% for obj in group.children %}
-        {% include "dispatch.html" with context %}
+        {% include "dispatch.html.jinja" with context %}
       {% endfor %}
     {% endfor %}
   </div>
 {% elif obj.children %}
   {{ log.debug("Rendering children of " + obj.path) }}
   <div class="doc doc-children">
     {% for obj in obj.children %}
-      {% include "dispatch.html" with context %}
+      {% include "dispatch.html.jinja" with context %}
     {% endfor %}
   </div>
 {% endif %}

src/mkdocstrings_handlers/typescript/templates/material/_base/class.html.jinja

@@ -0,0 +1,68 @@
+{{ log.debug("Rendering " + class.path) }}
+
+<div class="doc doc-object doc-class">
+  {% with obj = class, html_id = class.path %}
+  
+    {% if root %}
+      {% set show_full_path = config.show_root_full_path %}
+      {% set root_members = True %}
+    {% elif root_members %}
+      {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+      {% set root_members = False %}
+    {% else %}
+      {% set show_full_path = config.show_object_full_path %}
+    {% endif %}
+  
+    {% set class_name = class.path if show_full_path else class.name %}
+  
+    {% if not root or config.show_root_heading %}
+      {% filter heading(
+          heading_level,
+          role="class",
+          id=html_id,
+          class="doc doc-heading",
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + class.name,
+      ) %}
+  
+        {% block heading scoped %}
+          {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>{% endif %}
+          {% if config.separate_signature %}
+            <span class="doc doc-object-name doc-class-name">{{ class_name }}</span>
+          {% else %}
+            <code>{{ class_name }}</code>
+          {% endif %}
+        {% endblock heading %}
+  
+      {% endfilter %}
+  
+    {% else %}
+      {% if config.show_root_toc_entry %}
+        {% filter heading(heading_level,
+            role="class",
+            id=html_id,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + class.name,
+            hidden=True,
+        ) %}
+        {% endfilter %}
+      {% endif %}
+      {% set heading_level = heading_level - 1 %}
+    {% endif %}
+  
+    <div class="doc doc-contents {% if root %}first{% endif %}">
+      {% block contents scoped %}
+        {% block docstring scoped %}
+          {% if class.comment %}
+            {{ class.comment.markdown|convert_markdown(heading_level, html_id) }}
+          {% endif %}
+        {% endblock docstring %}
+        {% block children scoped %}
+          {% set root = False %}
+          {% set heading_level = heading_level + 1 %}
+          {% include "children.html.jinja" with context %}
+        {% endblock children %}
+      {% endblock contents %}
+    </div>
+  
+  {% endwith %}
+</div>
+  

src/mkdocstrings_handlers/typescript/templates/material/_base/constructor.html.jinja

@@ -0,0 +1,68 @@
+{{ log.debug("Rendering " + constructor.path) }}
+
+<div class="doc doc-object doc-constructor">
+  {% with obj = constructor, html_id = constructor.path %}
+  
+    {% if root %}
+      {% set show_full_path = config.show_root_full_path %}
+      {% set root_members = True %}
+    {% elif root_members %}
+      {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+      {% set root_members = False %}
+    {% else %}
+      {% set show_full_path = config.show_object_full_path %}
+    {% endif %}
+  
+    {% set constructor_name = constructor.path if show_full_path else constructor.name %}
+  
+    {% if not root or config.show_root_heading %}
+      {% filter heading(
+          heading_level,
+          role="constructor",
+          id=html_id,
+          class="doc doc-heading",
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-constructor"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + constructor.name,
+      ) %}
+  
+        {% block heading scoped %}
+          {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-constructor"></code>{% endif %}
+          {% if config.separate_signature %}
+            <span class="doc doc-object-name doc-constructor-name">{{ constructor_name }}</span>
+          {% else %}
+            <code>{{ constructor_name }}</code>
+          {% endif %}
+        {% endblock heading %}
+  
+      {% endfilter %}
+  
+    {% else %}
+      {% if config.show_root_toc_entry %}
+        {% filter heading(heading_level,
+            role="constructor",
+            id=html_id,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-constructor"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + constructor.name,
+            hidden=True,
+        ) %}
+        {% endfilter %}
+      {% endif %}
+      {% set heading_level = heading_level - 1 %}
+    {% endif %}
+  
+    <div class="doc doc-contents {% if root %}first{% endif %}">
+      {% block contents scoped %}
+        {% block docstring scoped %}
+          {% if constructor.comment %}
+            {{ constructor.comment.markdown|convert_markdown(heading_level, html_id) }}
+          {% endif %}
+        {% endblock docstring %}
+        {% block children scoped %}
+          {% set root = False %}
+          {% set heading_level = heading_level + 1 %}
+          {% include "children.html.jinja" with context %}
+        {% endblock children %}
+      {% endblock contents %}
+    </div>
+  
+  {% endwith %}
+</div>
+  

…t/templates/material/_base/dispatch.html …lates/material/_base/dispatch.html.jinjasrc/mkdocstrings_handlers/typescript/templates/material/_base/dispatch.html renamed to src/mkdocstrings_handlers/typescript/templates/material/_base/dispatch.html.jinja src/mkdocstrings_handlers/typescript/templates/material/_base/dispatch.html renamed to src/mkdocstrings_handlers/typescript/templates/material/_base/dispatch.html.jinja

@@ -1,94 +1,94 @@
 {{ log.debug("Dispatching " ~ obj.kind.value) }}
 {% if obj.kind.value == "project" %}
   {% with project = obj  %}
-    {% include "project.html" with context %}
+    {% include "project.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "module" and config.show_submodules %}
   {% with module = obj  %}
-    {% include "module.html" with context %}
+    {% include "module.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "namespace" %}
   {% with namespace = obj  %}
-    {% include "namespace.html" with context %}
+    {% include "namespace.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "enum" %}
   {% with enum = obj  %}
-    {% include "enum.html" with context %}
+    {% include "enum.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "enum_member" %}
   {% with enum_member = obj  %}
-    {% include "enum_member.html" with context %}
+    {% include "enum_member.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "variable" %}
   {% with variable = obj  %}
-    {% include "variable.html" with context %}
+    {% include "variable.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "function" %}
   {% with function = obj  %}
-    {% include "function.html" with context %}
+    {% include "function.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "class" %}
   {% with class = obj  %}
-    {% include "class.html" with context %}
+    {% include "class.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "interface" %}
   {% with interface = obj  %}
-    {% include "interface.html" with context %}
+    {% include "interface.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "constructor" %}
   {% with constructor = obj  %}
-    {% include "constructor.html" with context %}
+    {% include "constructor.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "property" %}
   {% with property = obj  %}
-    {% include "property.html" with context %}
+    {% include "property.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "method" %}
   {% with method = obj  %}
-    {% include "method.html" with context %}
+    {% include "method.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "call_signature" %}
   {% with call_signature = obj  %}
-    {% include "call_signature.html" with context %}
+    {% include "call_signature.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "index_signature" %}
   {% with index_signature = obj  %}
-    {% include "index_signature.html" with context %}
+    {% include "index_signature.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "constructor_signature" %}
   {% with constructor_signature = obj  %}
-    {% include "constructor_signature.html" with context %}
+    {% include "constructor_signature.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "parameter" %}
   {% with parameter = obj  %}
-    {% include "parameter.html" with context %}
+    {% include "parameter.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "type_literal" %}
   {% with type_literal = obj  %}
-    {% include "type_literal.html" with context %}
+    {% include "type_literal.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "type_parameter" %}
   {% with type_parameter = obj  %}
-    {% include "type_parameter.html" with context %}
+    {% include "type_parameter.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "accessor" %}
   {% with accessor = obj  %}
-    {% include "accessor.html" with context %}
+    {% include "accessor.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "get_signature" %}
   {% with get_signature = obj  %}
-    {% include "get_signature.html" with context %}
+    {% include "get_signature.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "set_signature" %}
   {% with set_signature = obj  %}
-    {% include "set_signature.html" with context %}
+    {% include "set_signature.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "type_alias" %}
   {% with type_alias = obj  %}
-    {% include "type_alias.html" with context %}
+    {% include "type_alias.html.jinja" with context %}
   {% endwith %}
 {% elif obj.kind.value == "reference" %}
   {% with reference = obj  %}
-    {% include "reference.html" with context %}
+    {% include "reference.html.jinja" with context %}
   {% endwith %}
 {% endif %}

src/mkdocstrings_handlers/typescript/templates/material/_base/enum.html.jinja

@@ -0,0 +1,68 @@
+{{ log.debug("Rendering " + enum.path) }}
+
+<div class="doc doc-object doc-enum">
+  {% with obj = enum, html_id = enum.path %}
+  
+    {% if root %}
+      {% set show_full_path = config.show_root_full_path %}
+      {% set root_members = True %}
+    {% elif root_members %}
+      {% set show_full_path = config.show_root_members_full_path or config.show_object_full_path %}
+      {% set root_members = False %}
+    {% else %}
+      {% set show_full_path = config.show_object_full_path %}
+    {% endif %}
+  
+    {% set enum_name = enum.path if show_full_path else enum.name %}
+  
+    {% if not root or config.show_root_heading %}
+      {% filter heading(
+          heading_level,
+          role="enum",
+          id=html_id,
+          class="doc doc-heading",
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-enum"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + enum.name,
+      ) %}
+  
+        {% block heading scoped %}
+          {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-enum"></code>{% endif %}
+          {% if config.separate_signature %}
+            <span class="doc doc-object-name doc-enum-name">{{ enum_name }}</span>
+          {% else %}
+            <code>{{ enum_name }}</code>
+          {% endif %}
+        {% endblock heading %}
+  
+      {% endfilter %}
+  
+    {% else %}
+      {% if config.show_root_toc_entry %}
+        {% filter heading(heading_level,
+            role="enum",
+            id=html_id,
+            toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-enum"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + enum.name,
+            hidden=True,
+        ) %}
+        {% endfilter %}
+      {% endif %}
+      {% set heading_level = heading_level - 1 %}
+    {% endif %}
+  
+    <div class="doc doc-contents {% if root %}first{% endif %}">
+      {% block contents scoped %}
+        {% block docstring scoped %}
+          {% if enum.comment %}
+            {{ enum.comment.markdown|convert_markdown(heading_level, html_id) }}
+          {% endif %}
+        {% endblock docstring %}
+        {% block children scoped %}
+          {% set root = False %}
+          {% set heading_level = heading_level + 1 %}
+          {% include "children.html.jinja" with context %}
+        {% endblock children %}
+      {% endblock contents %}
+    </div>
+  
+  {% endwith %}
+</div>
+