Prevent unwanted whitespace around method headings

Author: oprypin

mkdocstrings/handlers/crystal/renderer.py

@@ -66,13 +66,20 @@ def update_env(self, md: Markdown, config: dict) -> None:
         self.env.filters["convert_markdown"] = self.do_convert_markdown
         self.env.filters["reference"] = self.do_reference
 
-    def do_code_highlight(self, code, **kwargs) -> str:
+    def do_code_highlight(self, code, *, title: str = "", **kwargs) -> str:
         text = str(code)
         stext = text.lstrip()
         indent = text[: len(text) - len(stext)]
-        html = indent + self.env.filters["highlight"](stext, **kwargs)
+        html = self.env.filters["highlight"](stext, **kwargs)
+        # HACK: Replace the end of the first tag with injected content.
+        tag_end = Markup(">")
+        if indent:
+            html = html.replace(tag_end, tag_end + indent, 1)
         if isinstance(code, crystal_html.TextWithLinks):
             html = crystal_html.linkify_highlighted_html(html, code.tokens, self.do_reference)
+        if title:
+            prefix = Markup('<span class="doc-title">{}</span>').format(title)
+            html = html.replace(tag_end, tag_end + prefix, 1)
         return html
 
     def do_reference(self, path: Union[str, DocPath], text: Optional[str] = None) -> str:

mkdocstrings/templates/crystal/material/constant.html

@@ -1,9 +1,9 @@
 {{ log.debug() }}
 
 <div class="doc doc-object doc-{{ obj.kind }}">
-  {% filter heading(heading_level, id=obj.abs_id, class="doc doc-heading", toc_label=obj.name) %}
-    <code>{{ obj.name }} = <span style="font-weight: normal">{{ obj.value |code_highlight(language="crystal", inline=True) }}</span></code>
-  {% endfilter %}
+  {% filter heading(heading_level, id=obj.abs_id, class="doc doc-heading", toc_label=obj.name) -%}
+    {{ obj.value |code_highlight(title=obj.name + " = ", language="crystal", inline=True) }}
+  {%- endfilter %}
 
   <div class="doc doc-contents {% if root %}first{% endif %}">
     {% if obj.doc %}{{ obj.doc |convert_markdown(obj, heading_level, obj.abs_id) }}{% endif %}

mkdocstrings/templates/crystal/material/method.html

@@ -1,10 +1,10 @@
 {{ log.debug() }}
 
 <div class="doc doc-object doc-method doc-{{ obj.kind }}">
-  {% filter heading(heading_level, id=obj.abs_id, class="doc doc-heading", toc_label=obj.short_name) %}
-    {% if obj.is_abstract %}<small style="font-weight: normal">abstract</small> {% endif %}
-    <code>{{ obj.short_name }}<span style="font-weight: normal">{{ obj.args_string |code_highlight(language="crystal", inline=True) }}</span></code>
-  {% endfilter %}
+  {% filter heading(heading_level, id=obj.abs_id, class="doc doc-heading", toc_label=obj.short_name) -%}
+    {% if obj.is_abstract %}<small>abstract</small> {% endif %}
+    {{ obj.args_string |code_highlight(title=obj.short_name, language="crystal", inline=True) }}
+  {%- endfilter %}
 
   <div class="doc doc-contents {% if root %}first{% endif %}">
     {% if obj.doc %}{{ obj.doc |convert_markdown(obj, heading_level, obj.abs_id) }}{% endif %}

mkdocstrings/templates/crystal/material/type.html

@@ -2,12 +2,12 @@
 
 <div class="doc doc-object doc-type {{ obj.kind }}">
   {% if obj.parent %}
-  {% filter heading(heading_level, id=obj.abs_id, class="doc doc-heading", toc_label=obj.name) %}
+  {% filter heading(heading_level, id=obj.abs_id, class="doc doc-heading", toc_label=obj.name) -%}
     {% if obj.is_abstract %}abstract {% endif %}{{ obj.kind }} <code>{{ obj.full_name }}</code>
     {% if obj.superclass %}
       <br/><small>inherits <code>{{ obj.superclass |reference }}</code></small>
     {% endif %}
-  {% endfilter %}
+  {%- endfilter %}
   {% endif %}
 
   <div class="doc doc-contents {% if root %}first{% endif %}">