feat: Wrap objects names in spans to allow custom styling

Spans are only used when signatures are separated. Issue mkdocstrings/mkdocstrings#240: mkdocstrings/mkdocstrings#240
mkdocstrings · Apr 29, 2022 · 0822ff9 · 0822ff9
1 parent 8fed314
commit 0822ff9
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 6 deletions.
diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html b/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html
@@ -22,7 +22,7 @@
         toc_label=attribute.name) %}
 
       {% if config.separate_signature %}
-        {% if show_full_path %}{{ attribute.path }}{% else %}{{ attribute.name }}{% endif %}
+        <span class="doc doc-object-name doc-attribute-name">{% if show_full_path %}{{ attribute.path }}{% else %}{{ attribute.name }}{% endif %}</span>
       {% else %}
         {% filter highlight(language="python", inline=True) %}
           {% if show_full_path %}{{ attribute.path }}{% else %}{{ attribute.name }}{% endif %}

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/class.html b/src/mkdocstrings_handlers/python/templates/material/_base/class.html
@@ -22,7 +22,7 @@
         toc_label=class.name) %}
 
       {% if config.separate_signature %}
-        {% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}
+        <span class="doc doc-object-name doc-class-name">{% if show_full_path %}{{ class.path }}{% else %}{{ class.name }}{% endif %}</span>
       {% elif config.merge_init_into_class and "__init__" in class.members -%}
         {%- with function = class.members["__init__"] -%}
           {%- filter highlight(language="python", inline=True) -%}

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/function.html b/src/mkdocstrings_handlers/python/templates/material/_base/function.html
@@ -22,7 +22,7 @@
         toc_label=function.name ~ "()") %}
 
       {% if config.separate_signature %}
-        {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}
+        <span class="doc doc-object-name doc-function-name">{% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}</span>
       {% else %}
         {% filter highlight(language="python", inline=True) %}
           {% if show_full_path %}{{ function.path }}{% else %}{{ function.name }}{% endif %}

diff --git a/src/mkdocstrings_handlers/python/templates/material/_base/module.html b/src/mkdocstrings_handlers/python/templates/material/_base/module.html
@@ -21,9 +21,13 @@
         class="doc doc-heading",
         toc_label=module.name) %}
 
-      {% if not config.separate_signature %}<code>{% endif %}
-      {% if show_full_path %}{{ module.path }}{% else %}{{ module.name }}{% endif %}
-      {% if not config.separate_signature %}</code>{% endif %}
+      {% with module_name = module.path if show_full_path else module.name %}
+        {% if config.separate_signature %}
+          <span class="doc doc-object-name doc-module-name">{{ module_name }}</span>
+        {% else %}
+          <code>{{ module_name }}</code>
+        {% endif %}
+      {% endwith %}
 
       {% with labels = module.labels %}
         {% include "labels.html" with context %}