Skip to content

Commit 9fd859f

Browse files
pawamoypawamoy
committed
fixup
1 parent d099112 commit 9fd859f

File tree

35 files changed

+187
-365
lines changed

35 files changed

+187
-365
lines changed

‎src/mkdocstrings_handlers/python/__init__.py‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,14 @@
2222
do_as_classes_section,
2323
do_as_functions_section,
2424
do_as_modules_section,
25+
do_as_type_aliases_section,
2526
do_backlink_tree,
2627
do_crossref,
2728
do_filter_objects,
2829
do_format_attribute,
2930
do_format_code,
3031
do_format_signature,
32+
do_format_type_alias,
3133
do_get_template,
3234
do_multi_crossref,
3335
do_order_members,
@@ -55,12 +57,14 @@
5557
"do_as_classes_section",
5658
"do_as_functions_section",
5759
"do_as_modules_section",
60+
"do_as_type_aliases_section",
5861
"do_backlink_tree",
5962
"do_crossref",
6063
"do_filter_objects",
6164
"do_format_attribute",
6265
"do_format_code",
6366
"do_format_signature",
67+
"do_format_type_alias",
6468
"do_get_template",
6569
"do_multi_crossref",
6670
"do_order_members",

‎src/mkdocstrings_handlers/python/_internal/rendering.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
from __future__ import annotations
44

5-
from dataclasses import replace
65
import random
76
import re
87
import string
@@ -11,6 +10,7 @@
1110
import warnings
1211
from collections import defaultdict
1312
from contextlib import suppress
13+
from dataclasses import replace
1414
from functools import lru_cache
1515
from pathlib import Path
1616
from re import Match, Pattern

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -65,10 +65,8 @@ Context:
6565
{% endfilter %}
6666
{% endwith %}
6767
{% else %}
68-
{%+ filter highlight(language="python", inline=True) %}
69-
{#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. -#}
70-
{{ class_name }}{% include "type_parameters"|get_template with context %}
71-
{% endfilter %}
68+
{# TODO: Maybe render type parameters here. #}
69+
<code>{{ class_name }}</code>
7270
{% endif %}
7371
{% endblock heading %}
7472

‎tests/snapshots/members/filters=('!module_attribute',),inherited_members=('method1',),members=None.html‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,8 @@ <h1 class="doc doc-heading" id="members_package">
2323
<div class="doc doc-children">
2424
<div class="doc doc-object doc-class">
2525
<h2 class="doc doc-heading" id="members_package.Class">
26-
<code class="highlight language-python">
27-
<span class="n">
28-
Class
29-
</span>
26+
<code>
27+
Class
3028
</code>
3129
</h2>
3230
<div class="doc doc-contents">
@@ -113,10 +111,8 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
113111
</div>
114112
<div class="doc doc-object doc-class">
115113
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
116-
<code class="highlight language-python">
117-
<span class="n">
118-
NestedClass
119-
</span>
114+
<code>
115+
NestedClass
120116
</code>
121117
</h3>
122118
<div class="doc doc-contents">
@@ -233,10 +229,8 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
233229
</div>
234230
<div class="doc doc-object doc-class">
235231
<h2 class="doc doc-heading" id="members_package.Subclass">
236-
<code class="highlight language-python">
237-
<span class="n">
238-
Subclass
239-
</span>
232+
<code>
233+
Subclass
240234
</code>
241235
</h2>
242236
<div class="doc doc-contents">

‎tests/snapshots/members/filters=('!module_attribute',),inherited_members=('method1',),members=True.html‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,8 @@ <h2 class="doc doc-heading" id="members_package.module_attribute">
5454
</div>
5555
<div class="doc doc-object doc-class">
5656
<h2 class="doc doc-heading" id="members_package.Class">
57-
<code class="highlight language-python">
58-
<span class="n">
59-
Class
60-
</span>
57+
<code>
58+
Class
6159
</code>
6260
</h2>
6361
<div class="doc doc-contents">
@@ -144,10 +142,8 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
144142
</div>
145143
<div class="doc doc-object doc-class">
146144
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
147-
<code class="highlight language-python">
148-
<span class="n">
149-
NestedClass
150-
</span>
145+
<code>
146+
NestedClass
151147
</code>
152148
</h3>
153149
<div class="doc doc-contents">
@@ -264,10 +260,8 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
264260
</div>
265261
<div class="doc doc-object doc-class">
266262
<h2 class="doc doc-heading" id="members_package.Subclass">
267-
<code class="highlight language-python">
268-
<span class="n">
269-
Subclass
270-
</span>
263+
<code>
264+
Subclass
271265
</code>
272266
</h2>
273267
<div class="doc doc-contents">

‎tests/snapshots/members/filters=('!module_attribute',),inherited_members=(),members=None.html‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,8 @@ <h1 class="doc doc-heading" id="members_package">
2121
<div class="doc doc-children">
2222
<div class="doc doc-object doc-class">
2323
<h2 class="doc doc-heading" id="members_package.Class">
24-
<code class="highlight language-python">
25-
<span class="n">
26-
Class
27-
</span>
24+
<code>
25+
Class
2826
</code>
2927
</h2>
3028
<div class="doc doc-contents">
@@ -111,10 +109,8 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
111109
</div>
112110
<div class="doc doc-object doc-class">
113111
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
114-
<code class="highlight language-python">
115-
<span class="n">
116-
NestedClass
117-
</span>
112+
<code>
113+
NestedClass
118114
</code>
119115
</h3>
120116
<div class="doc doc-contents">
@@ -231,10 +227,8 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
231227
</div>
232228
<div class="doc doc-object doc-class">
233229
<h2 class="doc doc-heading" id="members_package.Subclass">
234-
<code class="highlight language-python">
235-
<span class="n">
236-
Subclass
237-
</span>
230+
<code>
231+
Subclass
238232
</code>
239233
</h2>
240234
<div class="doc doc-contents">

‎tests/snapshots/members/filters=('!module_attribute',),inherited_members=(),members=True.html‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,8 @@ <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 class="highlight language-python">
56-
<span class="n">
57-
Class
58-
</span>
55+
<code>
56+
Class
5957
</code>
6058
</h2>
6159
<div class="doc doc-contents">
@@ -142,10 +140,8 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
142140
</div>
143141
<div class="doc doc-object doc-class">
144142
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
145-
<code class="highlight language-python">
146-
<span class="n">
147-
NestedClass
148-
</span>
143+
<code>
144+
NestedClass
149145
</code>
150146
</h3>
151147
<div class="doc doc-contents">
@@ -262,10 +258,8 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
262258
</div>
263259
<div class="doc doc-object doc-class">
264260
<h2 class="doc doc-heading" id="members_package.Subclass">
265-
<code class="highlight language-python">
266-
<span class="n">
267-
Subclass
268-
</span>
261+
<code>
262+
Subclass
269263
</code>
270264
</h2>
271265
<div class="doc doc-contents">

‎tests/snapshots/members/filters=('!module_attribute',),inherited_members=False,members=None.html‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,8 @@ <h1 class="doc doc-heading" id="members_package">
2121
<div class="doc doc-children">
2222
<div class="doc doc-object doc-class">
2323
<h2 class="doc doc-heading" id="members_package.Class">
24-
<code class="highlight language-python">
25-
<span class="n">
26-
Class
27-
</span>
24+
<code>
25+
Class
2826
</code>
2927
</h2>
3028
<div class="doc doc-contents">
@@ -111,10 +109,8 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
111109
</div>
112110
<div class="doc doc-object doc-class">
113111
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
114-
<code class="highlight language-python">
115-
<span class="n">
116-
NestedClass
117-
</span>
112+
<code>
113+
NestedClass
118114
</code>
119115
</h3>
120116
<div class="doc doc-contents">
@@ -231,10 +227,8 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
231227
</div>
232228
<div class="doc doc-object doc-class">
233229
<h2 class="doc doc-heading" id="members_package.Subclass">
234-
<code class="highlight language-python">
235-
<span class="n">
236-
Subclass
237-
</span>
230+
<code>
231+
Subclass
238232
</code>
239233
</h2>
240234
<div class="doc doc-contents">

‎tests/snapshots/members/filters=('!module_attribute',),inherited_members=False,members=True.html‎

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,8 @@ <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 class="highlight language-python">
56-
<span class="n">
57-
Class
58-
</span>
55+
<code>
56+
Class
5957
</code>
6058
</h2>
6159
<div class="doc doc-contents">
@@ -142,10 +140,8 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
142140
</div>
143141
<div class="doc doc-object doc-class">
144142
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
145-
<code class="highlight language-python">
146-
<span class="n">
147-
NestedClass
148-
</span>
143+
<code>
144+
NestedClass
149145
</code>
150146
</h3>
151147
<div class="doc doc-contents">
@@ -262,10 +258,8 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
262258
</div>
263259
<div class="doc doc-object doc-class">
264260
<h2 class="doc doc-heading" id="members_package.Subclass">
265-
<code class="highlight language-python">
266-
<span class="n">
267-
Subclass
268-
</span>
261+
<code>
262+
Subclass
269263
</code>
270264
</h2>
271265
<div class="doc doc-contents">

‎tests/snapshots/members/filters=('!module_attribute',),inherited_members=True,members=None.html‎

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,8 @@ <h1 class="doc doc-heading" id="members_package">
2121
<div class="doc doc-children">
2222
<div class="doc doc-object doc-class">
2323
<h2 class="doc doc-heading" id="members_package.Class">
24-
<code class="highlight language-python">
25-
<span class="n">
26-
Class
27-
</span>
24+
<code>
25+
Class
2826
</code>
2927
</h2>
3028
<div class="doc doc-contents">
@@ -111,10 +109,8 @@ <h3 class="doc doc-heading" id="members_package.Class.instance_attribute">
111109
</div>
112110
<div class="doc doc-object doc-class">
113111
<h3 class="doc doc-heading" id="members_package.Class.NestedClass">
114-
<code class="highlight language-python">
115-
<span class="n">
116-
NestedClass
117-
</span>
112+
<code>
113+
NestedClass
118114
</code>
119115
</h3>
120116
<div class="doc doc-contents">
@@ -231,10 +227,8 @@ <h3 class="doc doc-heading" id="members_package.Class.method2">
231227
</div>
232228
<div class="doc doc-object doc-class">
233229
<h2 class="doc doc-heading" id="members_package.Subclass">
234-
<code class="highlight language-python">
235-
<span class="n">
236-
Subclass
237-
</span>
230+
<code>
231+
Subclass
238232
</code>
239233
</h2>
240234
<div class="doc doc-contents">
@@ -329,10 +323,8 @@ <h3 class="doc doc-heading" id="members_package.Subclass.instance_attribute">
329323
</div>
330324
<div class="doc doc-object doc-class">
331325
<h3 class="doc doc-heading" id="members_package.Subclass.NestedClass">
332-
<code class="highlight language-python">
333-
<span class="n">
334-
NestedClass
335-
</span>
326+
<code>
327+
NestedClass
336328
</code>
337329
</h3>
338330
<div class="doc doc-contents">

0 commit comments

Comments
 (0)