Switch to new handling of headings

From mkdocstrings/mkdocstrings#209

Author: oprypin

mkdocstrings/handlers/crystal/renderer.py

@@ -41,7 +41,7 @@ def get_anchor(self, data: DocItem) -> str:
         return data.abs_id
 
     def update_env(self, md: Markdown, config: dict) -> None:
-        md = Markdown(extensions=config["mdx"], extension_configs=config["mdx_configs"])
+        super().update_env(md, config)
         self._md = md
 
         self._pymdownx_hl = None
@@ -55,8 +55,6 @@ def update_env(self, md: Markdown, config: dict) -> None:
         del md.preprocessors["html_block"]
         del md.inlinePatterns["html"]
 
-        base.ShiftHeadingsExtension().extendMarkdown(md)
-        base.PrefixIdsExtension().extendMarkdown(md)
         md.treeprocessors.register(_RefInsertingTreeprocessor(md), "mkdocstrings_crystal_xref", 12)
 
         self.env.trim_blocks = True
@@ -92,9 +90,7 @@ def do_reference(self, path: Union[str, DocPath], text: Optional[str] = None) ->
 
     def do_convert_markdown(self, text: str, context: DocItem, heading_level: int, html_id: str):
         self._md.treeprocessors["mkdocstrings_crystal_xref"].context = context
-        return base.do_convert_markdown(
-            self._md, text, heading_level=heading_level, html_id=html_id
-        )
+        return super().do_convert_markdown(text, heading_level=heading_level, html_id=html_id)
 
     def _monkeypatch_highlight_function(self, default_lang: str):
         """Changes 'pymdownx.highlight' extension to use this lang by default."""

mkdocstrings/templates/crystal/material/constant.html

@@ -1,15 +1,11 @@
 {{ log.debug() }}
 
 <div class="doc doc-object doc-{{ obj.kind }}">
-  <h{{ heading_level }}
-      id="{{ obj.abs_id }}"
-      class="doc doc-heading"
-      data-toc-label="{{ obj.name }}">
-
+  {% 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>
-  </h{{ heading_level }}>
+  {% 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,16 +1,12 @@
 {{ log.debug() }}
 
 <div class="doc doc-object doc-method doc-{{ obj.kind }}">
-  <h{{ heading_level }}
-      id="{{ obj.abs_id }}"
-      class="doc doc-heading"
-      data-toc-label="{{ obj.short_name }}">
-
+  {% 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>
-  </h{{ heading_level }}>
+  {% 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,16 +2,12 @@
 
 <div class="doc doc-object doc-type {{ obj.kind }}">
   {% if obj.parent %}
-  <h{{ heading_level }}
-      id="{{ obj.abs_id }}"
-      class="doc doc-heading"
-      data-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 %}
-  </h{{ heading_level }}>
+  {% endfilter %}
   {% endif %}
 
   <div class="doc doc-contents {% if root %}first{% endif %}">
@@ -39,7 +35,11 @@
         {% endfor %}
 
         {% if obj.constants %}
-          <h{{ heading_level }}>{% if obj.kind == "enum" %}Members{% else %}Constants{% endif %}</h{{ heading_level }}>
+          {% if obj.kind == "enum" %}
+            {% filter heading(heading_level, id=obj.abs_id ~ "-members") %}Members{% endfilter %}
+          {% else %}
+            {% filter heading(heading_level, id=obj.abs_id ~ "-constants") %}Constants{% endfilter %}
+          {% endif %}
           {% with heading_level = heading_level + 1 %}
             {% for obj in obj.constants %}
               {% include "constant.html" with context %}
@@ -53,7 +53,7 @@
             ("Macros", obj.macros),
         ] %}
           {% if sub %}
-            <h{{ heading_level }}>{{ title }}</h{{ heading_level }}>
+            {% filter heading(heading_level, id=obj.abs_id ~ "-" ~ title.lower().replace(" ", "-")) %}{{ title }}{% endfilter %}
             {% with heading_level = heading_level + 1 %}
               {% for obj in sub %}
                 {% include "method.html" with context %}

pyproject.toml

@@ -16,7 +16,7 @@ deduplicate-toc = "mkdocstrings.handlers.crystal.deduplicate_toc:DeduplicateTocE
 
 [tool.poetry.dependencies]
 python = "^3.7"
-mkdocstrings = ">=0.14.0b1"
+mkdocstrings = "^0.15.0"
 mkdocs-material = "^6.0.2"
 markupsafe = "^1.1.1"
 cached-property = "^1.5.2"