Skip to content

Commit a373895

Browse files
viccie30viccie30
committed
Highlight class name in heading
1 parent 941d0e5 commit a373895

File tree

37 files changed

+400
-218
lines changed

37 files changed

+400
-218
lines changed

‎src/mkdocstrings_handlers/python/rendering.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -554,7 +554,7 @@ def do_as_attributes_section(
554554
name=attribute.name,
555555
description=attribute.docstring.value.split("\n", 1)[0] if attribute.docstring else "",
556556
annotation=attribute.annotation,
557-
value=attribute.value, # type: ignore[arg-type]
557+
value=attribute.value,
558558
)
559559
for attribute in attributes
560560
if not check_public or attribute.is_public
@@ -691,8 +691,8 @@ def get_context(self) -> AutorefsHookInterface.Context:
691691
}.get(self.current_object.kind.value.lower(), "obj")
692692
origin = self.current_object.path
693693
try:
694-
filepath = self.current_object.docstring.parent.filepath # type: ignore[union-attr]
695-
lineno = self.current_object.docstring.lineno or 0 # type: ignore[union-attr]
694+
filepath = self.current_object.docstring.parent.filepath
695+
lineno = self.current_object.docstring.lineno or 0
696696
except AttributeError:
697697
filepath = self.current_object.filepath
698698
lineno = 0

‎src/mkdocstrings_handlers/python/templates/material/_base/class.html.jinja‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,9 @@ Context:
5656
{% endfilter %}
5757
{% endwith %}
5858
{% else %}
59-
<code>{{ class_name }}</code>
59+
{%+ filter highlight(language="python", inline=True) %}
60+
{{ class_name }}
61+
{% endfilter %}
6062
{% endif %}
6163
{% endblock heading %}
6264

‎tests/snapshots/__init__.py‎

Lines changed: 32 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@
1818
("separate_signature", False),
1919
("show_signature_annotations", True),
2020
("signature_crossrefs", True),
21-
): external("735fc6ffdb82*.html"),
21+
): external("59872531a086*.html"),
2222
(
2323
("separate_signature", False),
2424
("show_signature_annotations", False),
2525
("signature_crossrefs", True),
26-
): external("6a02b544c12c*.html"),
26+
): external("1c04883284f6*.html"),
2727
(
2828
("separate_signature", False),
2929
("show_signature_annotations", False),
3030
("signature_crossrefs", False),
31-
): external("b060b701543e*.html"),
31+
): external("b0761b5d88e0*.html"),
3232
(
3333
("separate_signature", True),
3434
("show_signature_annotations", True),
@@ -43,7 +43,7 @@
4343
("separate_signature", False),
4444
("show_signature_annotations", True),
4545
("signature_crossrefs", False),
46-
): external("d1216ebf8e30*.html"),
46+
): external("9c7eeb0d7bfb*.html"),
4747
},
4848
)
4949

@@ -55,10 +55,10 @@
5555
("members", False),
5656
): external("ab0ddac637b5*.html"),
5757
(("filters", None), ("inherited_members", True), ("members", True)): external(
58-
"0b1372d7f7c0*.html",
58+
"5206643f1d79*.html",
5959
),
6060
(("filters", ()), ("inherited_members", False), ("members", True)): external(
61-
"59a9e1ffb2f0*.html",
61+
"2688494d14e8*.html",
6262
),
6363
(
6464
("filters", ("!module_attribute",)),
@@ -74,7 +74,7 @@
7474
("members", ("module_attribute",)),
7575
): external("e90c3e0c85dd*.html"),
7676
(("filters", ()), ("inherited_members", True), ("members", True)): external(
77-
"e8be7a9b1410*.html",
77+
"bf3b380c0319*.html",
7878
),
7979
(
8080
("filters", ("module_attribute",)),
@@ -85,15 +85,15 @@
8585
("filters", ()),
8686
("inherited_members", ("method1",)),
8787
("members", True),
88-
): external("d540895f6bf9*.html"),
88+
): external("0e5bca1984e9*.html"),
8989
(("filters", ()), ("inherited_members", False), ("members", False)): external(
9090
"5cf0130e3b4f*.html",
9191
),
9292
(
9393
("filters", ("!module_attribute",)),
9494
("inherited_members", True),
9595
("members", True),
96-
): external("7c988c9e13ef*.html"),
96+
): external("dc101bbf9385*.html"),
9797
(
9898
("filters", ("!module_attribute",)),
9999
("inherited_members", False),
@@ -128,7 +128,7 @@
128128
("members", None),
129129
): external("cfcd41685591*.html"),
130130
(("filters", ()), ("inherited_members", False), ("members", None)): external(
131-
"a2c5be9bd5d1*.html",
131+
"ca8e03e3261a*.html",
132132
),
133133
(
134134
("filters", ("module_attribute",)),
@@ -157,7 +157,7 @@
157157
("filters", ("!module_attribute",)),
158158
("inherited_members", ("method1",)),
159159
("members", None),
160-
): external("3d072a22b951*.html"),
160+
): external("3313930abb15*.html"),
161161
(("filters", None), ("inherited_members", False), ("members", False)): external(
162162
"9bd282a6f2fe*.html",
163163
),
@@ -170,7 +170,7 @@
170170
"44e42f27bfe3*.html",
171171
),
172172
(("filters", None), ("inherited_members", False), ("members", None)): external(
173-
"f7711b8af768*.html",
173+
"2e4d65061027*.html",
174174
),
175175
(
176176
("filters", ("!module_attribute",)),
@@ -183,13 +183,13 @@
183183
("members", False),
184184
): external("f3f3acb6b51b*.html"),
185185
(("filters", None), ("inherited_members", ()), ("members", True)): external(
186-
"347d4ffe2cb3*.html",
186+
"4312e98ede3c*.html",
187187
),
188188
(
189189
("filters", ("!module_attribute",)),
190190
("inherited_members", True),
191191
("members", None),
192-
): external("ba51e100acd4*.html"),
192+
): external("8306095b18c4*.html"),
193193
(
194194
("filters", ("!module_attribute",)),
195195
("inherited_members", False),
@@ -216,10 +216,10 @@
216216
("members", ()),
217217
): external("d5a6bf59c663*.html"),
218218
(("filters", None), ("inherited_members", ()), ("members", None)): external(
219-
"88855b028417*.html",
219+
"06b3a345d3df*.html",
220220
),
221221
(("filters", ()), ("inherited_members", True), ("members", None)): external(
222-
"981438492e38*.html",
222+
"e555bf966edd*.html",
223223
),
224224
(
225225
("filters", ()),
@@ -230,25 +230,25 @@
230230
("filters", None),
231231
("inherited_members", ("method1",)),
232232
("members", None),
233-
): external("ae74b5980f9b*.html"),
233+
): external("adcc51aa0d87*.html"),
234234
(
235235
("filters", ("module_attribute",)),
236236
("inherited_members", True),
237237
("members", ()),
238238
): external("95f8e480937f*.html"),
239239
(("filters", None), ("inherited_members", False), ("members", True)): external(
240-
"831198033381*.html",
240+
"e22a35456321*.html",
241241
),
242242
(
243243
("filters", ("module_attribute",)),
244244
("inherited_members", True),
245245
("members", True),
246-
): external("052c34f22e4c*.html"),
246+
): external("d7988a46775a*.html"),
247247
(
248248
("filters", ("!module_attribute",)),
249249
("inherited_members", False),
250250
("members", None),
251-
): external("cdc8126d78b6*.html"),
251+
): external("94faed07f275*.html"),
252252
(
253253
("filters", ("module_attribute",)),
254254
("inherited_members", ("method1",)),
@@ -271,7 +271,7 @@
271271
("filters", None),
272272
("inherited_members", ("method1",)),
273273
("members", True),
274-
): external("7d5fe6653919*.html"),
274+
): external("f697469880cb*.html"),
275275
(
276276
("filters", ("!module_attribute",)),
277277
("inherited_members", True),
@@ -294,7 +294,7 @@
294294
("filters", ("module_attribute",)),
295295
("inherited_members", ()),
296296
("members", True),
297-
): external("46e56f39b10d*.html"),
297+
): external("c90af3fe1d72*.html"),
298298
(
299299
("filters", ()),
300300
("inherited_members", ()),
@@ -317,7 +317,7 @@
317317
("filters", ("module_attribute",)),
318318
("inherited_members", False),
319319
("members", True),
320-
): external("052e71e7e9d5*.html"),
320+
): external("059dc5c474ca*.html"),
321321
(
322322
("filters", None),
323323
("inherited_members", ("method1",)),
@@ -327,7 +327,7 @@
327327
("filters", ("!module_attribute",)),
328328
("inherited_members", ()),
329329
("members", True),
330-
): external("b4b490164ab1*.html"),
330+
): external("3ea5302e71e5*.html"),
331331
(
332332
("filters", ("!module_attribute",)),
333333
("inherited_members", ("method1",)),
@@ -342,20 +342,20 @@
342342
("filters", ("!module_attribute",)),
343343
("inherited_members", ()),
344344
("members", None),
345-
): external("728c13446301*.html"),
345+
): external("adcecdb71c09*.html"),
346346
(("filters", None), ("inherited_members", ()), ("members", ())): external(
347347
"f77f1c850398*.html",
348348
),
349349
(
350350
("filters", ("!module_attribute",)),
351351
("inherited_members", False),
352352
("members", True),
353-
): external("0fac4f5e7f45*.html"),
353+
): external("5e331d13e0e0*.html"),
354354
(("filters", None), ("inherited_members", True), ("members", None)): external(
355-
"cc19537fdba4*.html",
355+
"1895a0c88668*.html",
356356
),
357357
(("filters", ()), ("inherited_members", ()), ("members", None)): external(
358-
"e6a9b76f268c*.html",
358+
"76176ed54147*.html",
359359
),
360360
(
361361
("filters", ("!module_attribute",)),
@@ -366,7 +366,7 @@
366366
("filters", ("!module_attribute",)),
367367
("inherited_members", ("method1",)),
368368
("members", True),
369-
): external("0c2924ff976f*.html"),
369+
): external("14c3d2f7287b*.html"),
370370
(
371371
("filters", ("module_attribute",)),
372372
("inherited_members", ()),
@@ -376,7 +376,7 @@
376376
"b0a9b08f1f72*.html",
377377
),
378378
(("filters", ()), ("inherited_members", ()), ("members", True)): external(
379-
"fb65efbbfc3e*.html",
379+
"7f570c4de561*.html",
380380
),
381381
(
382382
("filters", ("module_attribute",)),
@@ -390,12 +390,12 @@
390390
("filters", ("module_attribute",)),
391391
("inherited_members", ("method1",)),
392392
("members", True),
393-
): external("a1167b14f5a7*.html"),
393+
): external("fa334e855708*.html"),
394394
(
395395
("filters", ()),
396396
("inherited_members", ("method1",)),
397397
("members", None),
398-
): external("f848d4a9e516*.html"),
398+
): external("57e7bb4ad48c*.html"),
399399
(
400400
("filters", ("module_attribute",)),
401401
("inherited_members", ()),

‎tests/snapshots/external/052e71e7e9d5bec710fb2d36b009122c48eca0a19d0611df530e607f5bacdf6f.html‎ renamed to ‎tests/snapshots/external/059dc5c474ca9f18b173398bbd93fbda465cdfd2189cb2e9ef37a3d46cccc337.html‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ <h2 class="doc doc-heading" id="members_package.module_attribute">
5252
</div>
5353
<div class="doc doc-object doc-class">
5454
<h2 class="doc doc-heading" id="members_package.Class">
55-
<code>
56-
Class
55+
<code class="highlight language-python">
56+
<span class="n">
57+
Class
58+
</span>
5759
</code>
5860
</h2>
5961
<div class="doc doc-contents">
@@ -70,8 +72,10 @@ <h2 class="doc doc-heading" id="members_package.Class">
7072
</div>
7173
<div class="doc doc-object doc-class">
7274
<h2 class="doc doc-heading" id="members_package.Subclass">
73-
<code>
74-
Subclass
75+
<code class="highlight language-python">
76+
<span class="n">
77+
Subclass
78+
</span>
7579
</code>
7680
</h2>
7781
<div class="doc doc-contents">

‎tests/snapshots/external/88855b0284174733b57edd2043e0e8cd6a1a0223055f08b80031452eb05d9484.html‎ renamed to ‎tests/snapshots/external/06b3a345d3df34cdb016206e9f4dce76c6ef07342d5a0b1a6f53d2db6372a110.html‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,10 @@ <h2 class="doc doc-heading" id="members_package.module_attribute">
5050
</div>
5151
<div class="doc doc-object doc-class">
5252
<h2 class="doc doc-heading" id="members_package.Class">
53-
<code>
54-
Class
53+
<code class="highlight language-python">
54+
<span class="n">
55+
Class
56+
</span>
5557
</code>
5658
</h2>
5759
<div class="doc doc-contents">
@@ -138,8 +140,10 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
138140
</div>
139141
<div class="doc doc-object doc-class">
140142
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
141-
<code>
142-
NestedClass
143+
<code class="highlight language-python">
144+
<span class="n">
145+
NestedClass
146+
</span>
143147
</code>
144148
</h3>
145149
<div class="doc doc-contents">
@@ -256,8 +260,10 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
256260
</div>
257261
<div class="doc doc-object doc-class">
258262
<h2 class="doc doc-heading" id="members_package.Subclass">
259-
<code>
260-
Subclass
263+
<code class="highlight language-python">
264+
<span class="n">
265+
Subclass
266+
</span>
261267
</code>
262268
</h2>
263269
<div class="doc doc-contents">

‎tests/snapshots/external/d540895f6bf91c8c8e4abc02f40529a61c6cec71b18da2e4f02206ec18b901ef.html‎ renamed to ‎tests/snapshots/external/0e5bca1984e9323ddda836bff6fd828d82f5c333a319b533d3e3785535a8b670.html‎

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,10 @@ <h2 class="doc doc-heading" id="members_package.module_attribute">
5252
</div>
5353
<div class="doc doc-object doc-class">
5454
<h2 class="doc doc-heading" id="members_package.Class">
55-
<code>
56-
Class
55+
<code class="highlight language-python">
56+
<span class="n">
57+
Class
58+
</span>
5759
</code>
5860
</h2>
5961
<div class="doc doc-contents">
@@ -140,8 +142,10 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
140142
</div>
141143
<div class="doc doc-object doc-class">
142144
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
143-
<code>
144-
NestedClass
145+
<code class="highlight language-python">
146+
<span class="n">
147+
NestedClass
148+
</span>
145149
</code>
146150
</h3>
147151
<div class="doc doc-contents">
@@ -258,8 +262,10 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
258262
</div>
259263
<div class="doc doc-object doc-class">
260264
<h2 class="doc doc-heading" id="members_package.Subclass">
261-
<code>
262-
Subclass
265+
<code class="highlight language-python">
266+
<span class="n">
267+
Subclass
268+
</span>
263269
</code>
264270
</h2>
265271
<div class="doc doc-contents">

0 commit comments

Comments
 (0)