Linkify function args (new feature in Crystal JSON)

crystal-lang/crystal#10109
mkdocstrings · Jan 2, 2021 · fe0d634 · fe0d634
1 parent bea6bfd
commit fe0d634
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/mkdocstrings/handlers/crystal/items.py b/mkdocstrings/handlers/crystal/items.py
@@ -9,6 +9,8 @@
 from cached_property import cached_property
 from mkdocstrings.handlers.base import CollectionError
 
+from . import crystal_html
+
 
 class DocItem(metaclass=abc.ABCMeta):
     """A representation of a documentable item from Crystal language.
@@ -309,9 +311,14 @@ def is_abstract(self):
     def args(self) -> Mapping[str, Any]:
         return self.data["args"]
 
-    @property
-    def args_string(self) -> str:
-        return re.sub(r"<[\w/].*?>", "", self.data["args_string"])
+    @cached_property
+    def args_html(self) -> crystal_html.TextWithLinks:
+        # https://github.com/crystal-lang/crystal/pull/10109
+        try:
+            html = self.data["args_html"]
+        except KeyError:
+            html = self.data["args_string"]
+        return crystal_html.parse_crystal_html(html)
 
     @cached_property
     def location(self) -> Optional[DocLocation]:

diff --git a/mkdocstrings/templates/crystal/material/method.html b/mkdocstrings/templates/crystal/material/method.html
@@ -8,7 +8,7 @@
 
     {% if obj.is_abstract %}<small style="font-weight: normal">abstract</small> {% endif %}
     <code>
-      {{ obj.short_name }}<span style="font-weight: normal">{{ obj.args_string |highlight(language="crystal", inline=True) }}</span>
+      {{ obj.short_name }}<span style="font-weight: normal">{{ obj.args_html |code_highlight(language="crystal", inline=True) }}</span>
     </code>
   </h{{ heading_level }}>