File tree 8 files changed +48
-0
lines changed
src/mkdocstrings_handlers/python/templates/material/_base/docstring
8 files changed +48
-0
lines changed Original file line number Diff line number Diff line change 1
1
{{ log.debug("Rendering attributes section") }}
2
2
{% if config.docstring_section_style == "table" %}
3
+ {% block table_style %}
3
4
< p > < strong > {{ section.title or "Attributes:" }}</ strong > </ p >
4
5
< table >
5
6
< thead >
25
26
{% endfor %}
26
27
</ tbody >
27
28
</ table >
29
+ {% endblock table_style %}
28
30
{% elif config.docstring_section_style == "list" %}
31
+ {% block list_style %}
29
32
< p > {{ section.title or "Attributes:" }}</ p >
30
33
< ul >
31
34
{% for attribute in section.value %}
40
43
</ li >
41
44
{% endfor %}
42
45
</ ul >
46
+ {% endblock list_style %}
43
47
{% elif config.docstring_section_style == "spacy" %}
48
+ {% block spacy_style %}
44
49
< table >
45
50
< thead >
46
51
< tr >
69
74
{% endfor %}
70
75
</ tbody >
71
76
</ table >
77
+ {% endblock spacy_style %}
72
78
{% endif %}
Original file line number Diff line number Diff line change 1
1
{{ log.debug("Rendering other parameters section") }}
2
2
{% if config.docstring_section_style == "table" %}
3
+ {% block table_style %}
3
4
< p > < strong > {{ section.title or "Other Parameters:" }}</ strong > </ p >
4
5
< table >
5
6
< thead >
25
26
{% endfor %}
26
27
</ tbody >
27
28
</ table >
29
+ {% endblock table_style %}
28
30
{% elif config.docstring_section_style == "list" %}
31
+ {% block list_style %}
29
32
< p > {{ section.title or "Other Parameters:" }}</ p >
30
33
< ul >
31
34
{% for parameter in section.value %}
40
43
</ li >
41
44
{% endfor %}
42
45
</ ul >
46
+ {% endblock list_style %}
43
47
{% elif config.docstring_section_style == "spacy" %}
48
+ {% block spacy_style %}
44
49
< table >
45
50
< thead >
46
51
< tr >
69
74
{% endfor %}
70
75
</ tbody >
71
76
</ table >
77
+ {% endblock spacy_style %}
72
78
{% endif %}
Original file line number Diff line number Diff line change 1
1
{{ log.debug("Rendering parameters section") }}
2
2
{% if config.docstring_section_style == "table" %}
3
+ {% block table_style %}
3
4
< p > < strong > {{ section.title or "Parameters:" }}</ strong > </ p >
4
5
< table >
5
6
< thead >
35
36
{% endfor %}
36
37
</ tbody >
37
38
</ table >
39
+ {% endblock table_style %}
38
40
{% elif config.docstring_section_style == "list" %}
41
+ {% block list_style %}
39
42
< p > {{ section.title or "Parameters:" }}</ p >
40
43
< ul >
41
44
{% for parameter in section.value %}
50
53
</ li >
51
54
{% endfor %}
52
55
</ ul >
56
+ {% endblock list_style %}
53
57
{% elif config.docstring_section_style == "spacy" %}
58
+ {% block spacy_style %}
54
59
< table >
55
60
< thead >
56
61
< tr >
87
92
{% endfor %}
88
93
</ tbody >
89
94
</ table >
95
+ {% endblock spacy_style %}
90
96
{% endif %}
Original file line number Diff line number Diff line change 1
1
{{ log.debug("Rendering raises section") }}
2
2
{% if config.docstring_section_style == "table" %}
3
+ {% block table_style %}
3
4
< p > < strong > {{ section.title or "Raises:" }}</ strong > </ p >
4
5
< table >
5
6
< thead >
23
24
{% endfor %}
24
25
</ tbody >
25
26
</ table >
27
+ {% endblock table_style %}
26
28
{% elif config.docstring_section_style == "list" %}
29
+ {% block list_style %}
27
30
< p > {{ section.title or "Raises:" }}</ p >
28
31
< ul >
29
32
{% for raises in section.value %}
38
41
</ li >
39
42
{% endfor %}
40
43
</ ul >
44
+ {% endblock list_style %}
41
45
{% elif config.docstring_section_style == "spacy" %}
46
+ {% block spacy_style %}
42
47
< table >
43
48
< thead >
44
49
< tr >
63
68
{% endfor %}
64
69
</ tbody >
65
70
</ table >
71
+ {% endblock spacy_style %}
66
72
{% endif %}
Original file line number Diff line number Diff line change 1
1
{{ log.debug("Rendering receives section") }}
2
2
{% if config.docstring_section_style == "table" %}
3
+ {% block table_style %}
3
4
{% set name_column = section.value|selectattr("name")|any %}
4
5
< p > < strong > {{ section.title or "Receives:" }}</ strong > </ p >
5
6
< table >
26
27
{% endfor %}
27
28
</ tbody >
28
29
</ table >
30
+ {% endblock table_style %}
29
31
{% elif config.docstring_section_style == "list" %}
32
+ {% block list_style %}
30
33
< p > {{ section.title or "Receives:" }}</ p >
31
34
< ul >
32
35
{% for receives in section.value %}
43
46
</ li >
44
47
{% endfor %}
45
48
</ ul >
49
+ {% endblock list_style %}
46
50
{% elif config.docstring_section_style == "spacy" %}
51
+ {% block spacy_style %}
47
52
< table >
48
53
< thead >
49
54
< tr >
82
87
{% endfor %}
83
88
</ tbody >
84
89
</ table >
90
+ {% endblock spacy_style %}
85
91
{% endif %}
Original file line number Diff line number Diff line change 1
1
{{ log.debug("Rendering returns section") }}
2
2
{% if config.docstring_section_style == "table" %}
3
+ {% block table_style %}
3
4
{% set name_column = section.value|selectattr("name")|any %}
4
5
< p > < strong > {{ section.title or "Returns:" }}</ strong > </ p >
5
6
< table >
26
27
{% endfor %}
27
28
</ tbody >
28
29
</ table >
30
+ {% endblock table_style %}
29
31
{% elif config.docstring_section_style == "list" %}
32
+ {% block list_style %}
30
33
< p > {{ section.title or "Returns:" }}</ p >
31
34
< ul >
32
35
{% for returns in section.value %}
43
46
</ li >
44
47
{% endfor %}
45
48
</ ul >
49
+ {% endblock list_style %}
46
50
{% elif config.docstring_section_style == "spacy" %}
51
+ {% block spacy_style %}
47
52
< table >
48
53
< thead >
49
54
< tr >
82
87
{% endfor %}
83
88
</ tbody >
84
89
</ table >
90
+ {% endblock spacy_style %}
85
91
{% endif %}
Original file line number Diff line number Diff line change 1
1
{{ log.debug("Rendering warns section") }}
2
2
{% if config.docstring_section_style == "table" %}
3
+ {% block table_style %}
3
4
< p > < strong > {{ section.title or "Warns:" }}</ strong > </ p >
4
5
< table >
5
6
< thead >
23
24
{% endfor %}
24
25
</ tbody >
25
26
</ table >
27
+ {% endblock table_style %}
26
28
{% elif config.docstring_section_style == "list" %}
29
+ {% block list_style %}
27
30
< p > {{ section.title or "Warns:" }}</ p >
28
31
< ul >
29
32
{% for warns in section.value %}
38
41
</ li >
39
42
{% endfor %}
40
43
</ ul >
44
+ {% endblock list_style %}
41
45
{% elif config.docstring_section_style == "spacy" %}
46
+ {% block spacy_style %}
42
47
< table >
43
48
< thead >
44
49
< tr >
63
68
{% endfor %}
64
69
</ tbody >
65
70
</ table >
71
+ {% endblock spacy_style %}
66
72
{% endif %}
Original file line number Diff line number Diff line change 1
1
{{ log.debug("Rendering yields section") }}
2
2
{% if config.docstring_section_style == "table" %}
3
+ {% block table_style %}
3
4
{% set name_column = section.value|selectattr("name")|any %}
4
5
< p > < strong > {{ section.title or "Yields:" }}</ strong > </ p >
5
6
< table >
26
27
{% endfor %}
27
28
</ tbody >
28
29
</ table >
30
+ {% endblock table_style %}
29
31
{% elif config.docstring_section_style == "list" %}
32
+ {% block list_style %}
30
33
< p > {{ section.title or "Yields:" }}</ p >
31
34
< ul >
32
35
{% for yields in section.value %}
43
46
</ li >
44
47
{% endfor %}
45
48
</ ul >
49
+ {% endblock list_style %}
46
50
{% elif config.docstring_section_style == "spacy" %}
51
+ {% block spacy_style %}
47
52
< table >
48
53
< thead >
49
54
< tr >
82
87
{% endfor %}
83
88
</ tbody >
84
89
</ table >
90
+ {% endblock spacy_style %}
85
91
{% endif %}
You can’t perform that action at this time.
0 commit comments