mkdocstrings-python 1.18.2__py3-none-any.whl → 2.0.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mkdocstrings_handlers/python/__init__.py +0 -4
- mkdocstrings_handlers/python/_internal/config.py +20 -48
- mkdocstrings_handlers/python/_internal/debug.py +1 -1
- mkdocstrings_handlers/python/_internal/handler.py +26 -45
- mkdocstrings_handlers/python/_internal/rendering.py +50 -113
- mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/material/_base/backlinks.html.jinja +49 -0
- mkdocstrings_handlers/python/templates/material/_base/class.html.jinja +58 -18
- mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja +4 -8
- mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html.jinja +4 -8
- mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja +7 -14
- mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html.jinja +4 -8
- mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html.jinja +5 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html.jinja +5 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/type_aliases.html.jinja +1 -1
- mkdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.html.jinja +9 -9
- mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html.jinja +4 -8
- mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinja +5 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja +15 -30
- mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja +3 -0
- mkdocstrings_handlers/python/templates/material/_base/function.html.jinja +6 -10
- mkdocstrings_handlers/python/templates/material/_base/language.html.jinja +3 -6
- mkdocstrings_handlers/python/templates/material/_base/module.html.jinja +4 -8
- mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja +3 -6
- mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/summary/type_aliases.html.jinja +1 -2
- mkdocstrings_handlers/python/templates/material/_base/summary.html.jinja +5 -10
- mkdocstrings_handlers/python/templates/material/_base/type_alias.html.jinja +3 -6
- mkdocstrings_handlers/python/templates/material/_base/type_parameters.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/material/style.css +24 -0
- mkdocstrings_handlers/python/templates/readthedocs/_base/class.html +11 -0
- mkdocstrings_handlers/python/templates/readthedocs/_base/class.html.jinja +251 -0
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html.jinja +3 -6
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html.jinja +2 -4
- mkdocstrings_handlers/python/templates/readthedocs/_base/language.html.jinja +3 -6
- mkdocstrings_handlers/python/templates/{material → readthedocs}/class.html +0 -1
- mkdocstrings_handlers/python/templates/readthedocs/class.html.jinja +1 -0
- mkdocstrings_python-2.0.0.dist-info/METADATA +179 -0
- mkdocstrings_python-2.0.0.dist-info/RECORD +121 -0
- {mkdocstrings_python-1.18.2.dist-info → mkdocstrings_python-2.0.0.dist-info}/WHEEL +1 -1
- mkdocstrings_handlers/python/config.py +0 -17
- mkdocstrings_handlers/python/handler.py +0 -17
- mkdocstrings_handlers/python/rendering.py +0 -17
- mkdocstrings_handlers/python/templates/material/_base/attribute.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/children.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/class.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/type_aliases.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/type_parameters.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/docstring.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/expression.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/function.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/labels.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/language.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/languages/en.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/languages/ja.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/languages/zh.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/module.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/signature.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/summary/classes.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/summary/functions.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/summary/modules.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/summary/type_aliases.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/summary.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/type_alias.html +0 -10
- mkdocstrings_handlers/python/templates/material/_base/type_parameters.html +0 -10
- mkdocstrings_handlers/python/templates/material/attribute.html +0 -2
- mkdocstrings_handlers/python/templates/material/children.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/admonition.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/attributes.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/classes.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/examples.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/functions.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/modules.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/parameters.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/raises.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/receives.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/returns.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/warns.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring/yields.html +0 -2
- mkdocstrings_handlers/python/templates/material/docstring.html +0 -2
- mkdocstrings_handlers/python/templates/material/expression.html +0 -2
- mkdocstrings_handlers/python/templates/material/function.html +0 -2
- mkdocstrings_handlers/python/templates/material/labels.html +0 -2
- mkdocstrings_handlers/python/templates/material/language.html +0 -2
- mkdocstrings_handlers/python/templates/material/languages/en.html +0 -2
- mkdocstrings_handlers/python/templates/material/languages/ja.html +0 -2
- mkdocstrings_handlers/python/templates/material/languages/zh.html +0 -2
- mkdocstrings_handlers/python/templates/material/module.html +0 -2
- mkdocstrings_handlers/python/templates/material/signature.html +0 -2
- mkdocstrings_handlers/python/templates/material/summary/attributes.html +0 -2
- mkdocstrings_handlers/python/templates/material/summary/classes.html +0 -2
- mkdocstrings_handlers/python/templates/material/summary/functions.html +0 -2
- mkdocstrings_handlers/python/templates/material/summary/modules.html +0 -2
- mkdocstrings_handlers/python/templates/material/summary.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/attributes.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/other_parameters.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/parameters.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/raises.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/receives.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/returns.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/warns.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/docstring/yields.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/language.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/languages/en.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/languages/ja.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/_base/languages/zh.html +0 -10
- mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/language.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/languages/en.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html +0 -2
- mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html +0 -2
- mkdocstrings_python-1.18.2.dist-info/METADATA +0 -117
- mkdocstrings_python-1.18.2.dist-info/RECORD +0 -211
- {mkdocstrings_python-1.18.2.dist-info → mkdocstrings_python-2.0.0.dist-info}/entry_points.txt +0 -0
- {mkdocstrings_python-1.18.2.dist-info → mkdocstrings_python-2.0.0.dist-info}/licenses/LICENSE +0 -0
|
@@ -57,11 +57,9 @@ Context:
|
|
|
57
57
|
{%+ filter highlight(language="python", inline=True) %}
|
|
58
58
|
{{ class_name -}}
|
|
59
59
|
{%- with obj = function -%}
|
|
60
|
-
{
|
|
61
|
-
{%- include "type_parameters"|get_template with context -%}
|
|
60
|
+
{%- include "type_parameters.html.jinja" with context -%}
|
|
62
61
|
{%- endwith -%}
|
|
63
|
-
{
|
|
64
|
-
{%- include "signature"|get_template with context -%}
|
|
62
|
+
{%- include "signature.html.jinja" with context -%}
|
|
65
63
|
{% endfilter %}
|
|
66
64
|
{% endwith %}
|
|
67
65
|
{% else %}
|
|
@@ -76,8 +74,7 @@ Context:
|
|
|
76
74
|
This block renders the labels for the class.
|
|
77
75
|
-#}
|
|
78
76
|
{% with labels = class.labels %}
|
|
79
|
-
{
|
|
80
|
-
{% include "labels"|get_template with context %}
|
|
77
|
+
{% include "labels.html.jinja" with context %}
|
|
81
78
|
{% endwith %}
|
|
82
79
|
{% endblock labels %}
|
|
83
80
|
|
|
@@ -148,8 +145,7 @@ Context:
|
|
|
148
145
|
Bases: {% for expression in class.bases -%}
|
|
149
146
|
<code>
|
|
150
147
|
{%- with backlink_type = "subclassed-by" -%}
|
|
151
|
-
{
|
|
152
|
-
{%- include "expression"|get_template with context -%}
|
|
148
|
+
{%- include "expression.html.jinja" with context -%}
|
|
153
149
|
{%- endwith -%}
|
|
154
150
|
</code>{% if not loop.last %}, {% endif %}
|
|
155
151
|
{% endfor -%}
|
|
@@ -157,14 +153,61 @@ Context:
|
|
|
157
153
|
{% endif %}
|
|
158
154
|
{% endblock bases %}
|
|
159
155
|
|
|
156
|
+
{% block inheritance_diagram scoped %}
|
|
157
|
+
{#- Inheritance diagram block.
|
|
158
|
+
|
|
159
|
+
This block renders the inheritance diagram for the class,
|
|
160
|
+
using Mermaid syntax and a bit of JavaScript to make the nodes clickable,
|
|
161
|
+
linking to the corresponding class documentation.
|
|
162
|
+
-#}
|
|
163
|
+
{% if config.show_inheritance_diagram and class.bases %}
|
|
164
|
+
{% macro edges(class) %}
|
|
165
|
+
{% for base in class.resolved_bases %}
|
|
166
|
+
{{ base.path }} --> {{ class.path }}
|
|
167
|
+
{{ edges(base) }}
|
|
168
|
+
{% endfor %}
|
|
169
|
+
{% endmacro %}
|
|
170
|
+
<div style="display: none">
|
|
171
|
+
<autoref identifier="{{ class.path }}" optional id="mermaid-link-{{ class.path }}"></autoref>
|
|
172
|
+
{% for base in class.mro() %}
|
|
173
|
+
<autoref identifier="{{ base.path }}" optional id="mermaid-link-{{ base.path }}"></autoref>
|
|
174
|
+
{% endfor %}
|
|
175
|
+
</div>
|
|
176
|
+
<pre class="mermaid"><code id="mermaid-diagram-{{ class.path }}">
|
|
177
|
+
flowchart {{ config.inheritance_diagram_direction }}
|
|
178
|
+
{{ class.path }}[{{ class.name }}]
|
|
179
|
+
{% for base in class.mro() %}
|
|
180
|
+
{{ base.path }}[{{ base.name }}]
|
|
181
|
+
{% endfor %}
|
|
182
|
+
|
|
183
|
+
{{ edges(class) | safe }}
|
|
184
|
+
|
|
185
|
+
click {{ class.path }} href "" "{{ class.path }}"
|
|
186
|
+
{% for base in class.mro() %}
|
|
187
|
+
click {{ base.path }} href "" "{{ base.path }}"
|
|
188
|
+
{% endfor %}
|
|
189
|
+
</code></pre>
|
|
190
|
+
<script>
|
|
191
|
+
var diagram = document.getElementById('mermaid-diagram-{{ class.path }}');
|
|
192
|
+
diagram.innerHTML = diagram.innerHTML.replace(/click ([\w.]+) href "" "\1"/g, function(match, nodeID, offset) {
|
|
193
|
+
try {
|
|
194
|
+
const link = document.getElementById("mermaid-link-" + nodeID).href;
|
|
195
|
+
return `click ${nodeID} href "${link}" "${nodeID}"`
|
|
196
|
+
} catch (e) {
|
|
197
|
+
return '';
|
|
198
|
+
}
|
|
199
|
+
});
|
|
200
|
+
</script>
|
|
201
|
+
{% endif %}
|
|
202
|
+
{% endblock inheritance_diagram %}
|
|
203
|
+
|
|
160
204
|
{% block docstring scoped %}
|
|
161
205
|
{#- Docstring block.
|
|
162
206
|
|
|
163
207
|
This block renders the docstring for the class.
|
|
164
208
|
-#}
|
|
165
209
|
{% with docstring_sections = class.docstring.parsed %}
|
|
166
|
-
{
|
|
167
|
-
{% include "docstring"|get_template with context %}
|
|
210
|
+
{% include "docstring.html.jinja" with context %}
|
|
168
211
|
{% endwith %}
|
|
169
212
|
{% if config.merge_init_into_class %}
|
|
170
213
|
{# We don't want to merge the inherited `__init__` method docstring into the class docstring #}
|
|
@@ -173,8 +216,7 @@ Context:
|
|
|
173
216
|
{% if "__init__" in check_members and check_members["__init__"].has_docstring %}
|
|
174
217
|
{% with function = check_members["__init__"] %}
|
|
175
218
|
{% with obj = function, docstring_sections = function.docstring.parsed %}
|
|
176
|
-
{
|
|
177
|
-
{% include "docstring"|get_template with context %}
|
|
219
|
+
{% include "docstring.html.jinja" with context %}
|
|
178
220
|
{% endwith %}
|
|
179
221
|
{% endwith %}
|
|
180
222
|
{% endif %}
|
|
@@ -191,8 +233,7 @@ Context:
|
|
|
191
233
|
|
|
192
234
|
This block renders auto-summaries for classes, methods, and attributes.
|
|
193
235
|
-#}
|
|
194
|
-
{
|
|
195
|
-
{% include "summary"|get_template with context %}
|
|
236
|
+
{% include "summary.html.jinja" with context %}
|
|
196
237
|
{% endblock summary %}
|
|
197
238
|
|
|
198
239
|
{% block source scoped %}
|
|
@@ -204,7 +245,7 @@ Context:
|
|
|
204
245
|
{% if config.merge_init_into_class %}
|
|
205
246
|
{% if "__init__" in all_members and all_members["__init__"].source %}
|
|
206
247
|
{% with init = all_members["__init__"] %}
|
|
207
|
-
<details class="
|
|
248
|
+
<details class="mkdocstrings-source">
|
|
208
249
|
<summary>Source code in <code>
|
|
209
250
|
{%- if init.relative_filepath.is_absolute() -%}
|
|
210
251
|
{{ init.relative_package_filepath }}
|
|
@@ -217,7 +258,7 @@ Context:
|
|
|
217
258
|
{% endwith %}
|
|
218
259
|
{% endif %}
|
|
219
260
|
{% elif class.source %}
|
|
220
|
-
<details class="
|
|
261
|
+
<details class="mkdocstrings-source">
|
|
221
262
|
<summary>Source code in <code>
|
|
222
263
|
{%- if class.relative_filepath.is_absolute() -%}
|
|
223
264
|
{{ class.relative_package_filepath }}
|
|
@@ -238,8 +279,7 @@ Context:
|
|
|
238
279
|
-#}
|
|
239
280
|
{% set root = False %}
|
|
240
281
|
{% set heading_level = heading_level + 1 %}
|
|
241
|
-
{
|
|
242
|
-
{% include "children"|get_template with context %}
|
|
282
|
+
{% include "children.html.jinja" with context %}
|
|
243
283
|
{% endblock children %}
|
|
244
284
|
{% endblock contents %}
|
|
245
285
|
</div>
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering attributes section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -38,8 +37,7 @@ Context:
|
|
|
38
37
|
<td>
|
|
39
38
|
{% if attribute.annotation %}
|
|
40
39
|
{% with expression = attribute.annotation %}
|
|
41
|
-
{
|
|
42
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
40
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
43
41
|
{% endwith %}
|
|
44
42
|
{% endif %}
|
|
45
43
|
</td>
|
|
@@ -63,8 +61,7 @@ Context:
|
|
|
63
61
|
<b><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></b>
|
|
64
62
|
{% if attribute.annotation %}
|
|
65
63
|
{% with expression = attribute.annotation %}
|
|
66
|
-
{
|
|
67
|
-
(<code>{% include "expression"|get_template with context %}</code>)
|
|
64
|
+
(<code>{% include "expression.html.jinja" with context %}</code>)
|
|
68
65
|
{% endwith %}
|
|
69
66
|
{% endif %}
|
|
70
67
|
–
|
|
@@ -98,8 +95,7 @@ Context:
|
|
|
98
95
|
<span class="doc-attribute-annotation">
|
|
99
96
|
<b>TYPE:</b>
|
|
100
97
|
{% with expression = attribute.annotation %}
|
|
101
|
-
{
|
|
102
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
98
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
103
99
|
{% endwith %}
|
|
104
100
|
</span>
|
|
105
101
|
{% endif %}
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering classes section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering examples section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
<p><span class="doc-section-title">{{ section.title or lang.t("Examples:") }}</span></p>
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering functions section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering modules section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering other parameters section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -38,8 +37,7 @@ Context:
|
|
|
38
37
|
<td>
|
|
39
38
|
{% if parameter.annotation %}
|
|
40
39
|
{% with expression = parameter.annotation, backlink_type = "used-by" %}
|
|
41
|
-
{
|
|
42
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
40
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
43
41
|
{% endwith %}
|
|
44
42
|
{% endif %}
|
|
45
43
|
</td>
|
|
@@ -63,8 +61,7 @@ Context:
|
|
|
63
61
|
<b><code>{{ parameter.name }}</code></b>
|
|
64
62
|
{% if parameter.annotation %}
|
|
65
63
|
{% with expression = parameter.annotation, backlink_type = "used-by" %}
|
|
66
|
-
{
|
|
67
|
-
(<code>{% include "expression"|get_template with context %}</code>)
|
|
64
|
+
(<code>{% include "expression.html.jinja" with context %}</code>)
|
|
68
65
|
{% endwith %}
|
|
69
66
|
{% endif %}
|
|
70
67
|
–
|
|
@@ -98,8 +95,7 @@ Context:
|
|
|
98
95
|
<span class="doc-param-annotation">
|
|
99
96
|
<b>{{ lang.t("TYPE:") }}</b>
|
|
100
97
|
{% with expression = parameter.annotation, backlink_type = "used-by" %}
|
|
101
|
-
{
|
|
102
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
98
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
103
99
|
{% endwith %}
|
|
104
100
|
</span>
|
|
105
101
|
{% endif %}
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering parameters section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -54,8 +53,7 @@ Context:
|
|
|
54
53
|
<td>
|
|
55
54
|
{% if parameter.annotation %}
|
|
56
55
|
{% with expression = parameter.annotation, backlink_type = "used-by" %}
|
|
57
|
-
{
|
|
58
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
56
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
59
57
|
{% endwith %}
|
|
60
58
|
{% endif %}
|
|
61
59
|
</td>
|
|
@@ -67,8 +65,7 @@ Context:
|
|
|
67
65
|
<td>
|
|
68
66
|
{% if parameter.default %}
|
|
69
67
|
{% with expression = parameter.default, backlink_type = "used-by" %}
|
|
70
|
-
{
|
|
71
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
68
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
72
69
|
{% endwith %}
|
|
73
70
|
{% else %}
|
|
74
71
|
<em>{{ lang.t("required") }}</em>
|
|
@@ -102,12 +99,10 @@ Context:
|
|
|
102
99
|
{% endif %}
|
|
103
100
|
{% if parameter.annotation %}
|
|
104
101
|
{% with expression = parameter.annotation, backlink_type = "used-by" %}
|
|
105
|
-
{
|
|
106
|
-
(<code>{% include "expression"|get_template with context %}</code>
|
|
102
|
+
(<code>{% include "expression.html.jinja" with context %}</code>
|
|
107
103
|
{%- if parameter.default %}, {{ lang.t("default:") }}
|
|
108
104
|
{% with expression = parameter.default, backlink_type = "used-by" %}
|
|
109
|
-
{
|
|
110
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
105
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
111
106
|
{% endwith %}
|
|
112
107
|
{% endif %})
|
|
113
108
|
{% endwith %}
|
|
@@ -158,8 +153,7 @@ Context:
|
|
|
158
153
|
<span class="doc-param-annotation">
|
|
159
154
|
<b>{{ lang.t("TYPE:") }}</b>
|
|
160
155
|
{% with expression = parameter.annotation, backlink_type = "used-by" %}
|
|
161
|
-
{
|
|
162
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
156
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
163
157
|
{% endwith %}
|
|
164
158
|
</span>
|
|
165
159
|
{% endif %}
|
|
@@ -167,8 +161,7 @@ Context:
|
|
|
167
161
|
<span class="doc-param-default">
|
|
168
162
|
<b>{{ lang.t("DEFAULT:") }}</b>
|
|
169
163
|
{% with expression = parameter.default, backlink_type = "used-by" %}
|
|
170
|
-
{
|
|
171
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
164
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
172
165
|
{% endwith %}
|
|
173
166
|
</span>
|
|
174
167
|
{% endif %}
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering raises section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -36,8 +35,7 @@ Context:
|
|
|
36
35
|
<td>
|
|
37
36
|
{% if raises.annotation %}
|
|
38
37
|
{% with expression = raises.annotation, backlink_type = "raised-by" %}
|
|
39
|
-
{
|
|
40
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
38
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
41
39
|
{% endwith %}
|
|
42
40
|
{% endif %}
|
|
43
41
|
</td>
|
|
@@ -60,8 +58,7 @@ Context:
|
|
|
60
58
|
<li class="doc-section-item field-body">
|
|
61
59
|
{% if raises.annotation %}
|
|
62
60
|
{% with expression = raises.annotation, backlink_type = "raised-by" %}
|
|
63
|
-
{
|
|
64
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
61
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
65
62
|
{% endwith %}
|
|
66
63
|
–
|
|
67
64
|
{% endif %}
|
|
@@ -88,8 +85,7 @@ Context:
|
|
|
88
85
|
<td>
|
|
89
86
|
<span class="doc-raises-annotation">
|
|
90
87
|
{% with expression = raises.annotation, backlink_type = "raised-by" %}
|
|
91
|
-
{
|
|
92
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
88
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
93
89
|
{% endwith %}
|
|
94
90
|
</span>
|
|
95
91
|
</td>
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering receives section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -39,8 +38,7 @@ Context:
|
|
|
39
38
|
<td>
|
|
40
39
|
{% if receives.annotation %}
|
|
41
40
|
{% with expression = receives.annotation, backlink_type = "received-by" %}
|
|
42
|
-
{
|
|
43
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
41
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
44
42
|
{% endwith %}
|
|
45
43
|
{% endif %}
|
|
46
44
|
</td>
|
|
@@ -65,8 +63,7 @@ Context:
|
|
|
65
63
|
{% if receives.annotation %}
|
|
66
64
|
{% with expression = receives.annotation, backlink_type = "received-by" %}
|
|
67
65
|
{% if receives.name %} ({% endif %}
|
|
68
|
-
{
|
|
69
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
66
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
70
67
|
{% if receives.name %}){% endif %}
|
|
71
68
|
{% endwith %}
|
|
72
69
|
{% endif %}
|
|
@@ -97,8 +94,7 @@ Context:
|
|
|
97
94
|
{% elif receives.annotation %}
|
|
98
95
|
<span class="doc-receives-annotation">
|
|
99
96
|
{% with expression = receives.annotation, backlink_type = "received-by" %}
|
|
100
|
-
{
|
|
101
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
97
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
102
98
|
{% endwith %}
|
|
103
99
|
</span>
|
|
104
100
|
{% endif %}
|
|
@@ -112,8 +108,7 @@ Context:
|
|
|
112
108
|
<span class="doc-receives-annotation">
|
|
113
109
|
<b>{{ lang.t("TYPE:") }}</b>
|
|
114
110
|
{% with expression = receives.annotation, backlink_type = "received-by" %}
|
|
115
|
-
{
|
|
116
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
111
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
117
112
|
{% endwith %}
|
|
118
113
|
</span>
|
|
119
114
|
</p>
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering returns section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -39,8 +38,7 @@ Context:
|
|
|
39
38
|
<td>
|
|
40
39
|
{% if returns.annotation %}
|
|
41
40
|
{% with expression = returns.annotation, backlink_type = "returned-by" %}
|
|
42
|
-
{
|
|
43
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
41
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
44
42
|
{% endwith %}
|
|
45
43
|
{% endif %}
|
|
46
44
|
</td>
|
|
@@ -65,8 +63,7 @@ Context:
|
|
|
65
63
|
{% if returns.annotation %}
|
|
66
64
|
{% with expression = returns.annotation, backlink_type = "returned-by" %}
|
|
67
65
|
{% if returns.name %} ({% endif %}
|
|
68
|
-
{
|
|
69
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
66
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
70
67
|
{% if returns.name %}){% endif %}
|
|
71
68
|
{% endwith %}
|
|
72
69
|
{% endif %}
|
|
@@ -97,8 +94,7 @@ Context:
|
|
|
97
94
|
{% elif returns.annotation %}
|
|
98
95
|
<span class="doc-returns-annotation">
|
|
99
96
|
{% with expression = returns.annotation, backlink_type = "returned-by" %}
|
|
100
|
-
{
|
|
101
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
97
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
102
98
|
{% endwith %}
|
|
103
99
|
</span>
|
|
104
100
|
{% endif %}
|
|
@@ -112,8 +108,7 @@ Context:
|
|
|
112
108
|
<span class="doc-returns-annotation">
|
|
113
109
|
<b>{{ lang.t("TYPE:") }}</b>
|
|
114
110
|
{% with expression = returns.annotation, backlink_type = "returned-by" %}
|
|
115
|
-
{
|
|
116
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
111
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
117
112
|
{% endwith %}
|
|
118
113
|
</span>
|
|
119
114
|
</p>
|
|
@@ -15,7 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering type aliases section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{% import "language"
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
19
19
|
{#- Language module providing the `t` translation method. -#}
|
|
20
20
|
|
|
21
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -15,7 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering type parameters section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{% import "language"
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
19
19
|
{#- Language module providing the `t` translation method. -#}
|
|
20
20
|
|
|
21
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -56,7 +56,7 @@ Context:
|
|
|
56
56
|
<td>
|
|
57
57
|
{% if type_parameter.annotation %}
|
|
58
58
|
{% with expression = type_parameter.annotation %}
|
|
59
|
-
<code>{% include "expression"
|
|
59
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
60
60
|
{% endwith %}
|
|
61
61
|
{% endif %}
|
|
62
62
|
</td>
|
|
@@ -68,7 +68,7 @@ Context:
|
|
|
68
68
|
<td>
|
|
69
69
|
{% if type_parameter.default %}
|
|
70
70
|
{% with expression = type_parameter.default %}
|
|
71
|
-
<code>{% include "expression"
|
|
71
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
72
72
|
{% endwith %}
|
|
73
73
|
{% else %}
|
|
74
74
|
<em>{{ lang.t("required") }}</em>
|
|
@@ -108,12 +108,12 @@ Context:
|
|
|
108
108
|
{%- endif -%}
|
|
109
109
|
{%- if type_parameter.bound -%}
|
|
110
110
|
{%- with expression = type_parameter.bound -%}
|
|
111
|
-
<code>{% include "expression"
|
|
111
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
112
112
|
{%- endwith -%}
|
|
113
113
|
{%- if type_parameter.default %}, {% endif -%}
|
|
114
114
|
{%- elif type_parameter.constraints -%}
|
|
115
115
|
{%- for expression in type_parameter.constraints -%}
|
|
116
|
-
<code>{% include "expression"
|
|
116
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
117
117
|
{%- if not loop.last %}, {% endif -%}
|
|
118
118
|
{%- endfor -%}
|
|
119
119
|
{%- if type_parameter.default %}, {% endif -%}
|
|
@@ -121,7 +121,7 @@ Context:
|
|
|
121
121
|
{%- if type_parameter.default -%}
|
|
122
122
|
{{ lang.t("default:") }}
|
|
123
123
|
{% with expression = type_parameter.default %}
|
|
124
|
-
<code>{% include "expression"
|
|
124
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
125
125
|
{%- endwith -%}
|
|
126
126
|
{%- endif -%}
|
|
127
127
|
{%- if type_parameter.constraints or type_parameter.default -%}
|
|
@@ -177,7 +177,7 @@ Context:
|
|
|
177
177
|
<b>{{ lang.t("CONSTRAINTS:") }}</b>
|
|
178
178
|
{% for constraint in type_parameter.constraints -%}
|
|
179
179
|
{%- with expression = constraint -%}
|
|
180
|
-
<code>{% include "expression"
|
|
180
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
181
181
|
{%- endwith -%}
|
|
182
182
|
{%- if not loop.last %}, {% endif -%}
|
|
183
183
|
{% endfor %}
|
|
@@ -186,7 +186,7 @@ Context:
|
|
|
186
186
|
<span class="doc-type_param-bound">
|
|
187
187
|
<b>{{ lang.t("BOUND:") }}</b>
|
|
188
188
|
{% with expression = type_parameter.bound %}
|
|
189
|
-
<code>{% include "expression"
|
|
189
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
190
190
|
{% endwith %}
|
|
191
191
|
</span>
|
|
192
192
|
{% endif %}
|
|
@@ -194,7 +194,7 @@ Context:
|
|
|
194
194
|
<span class="doc-type_param-default">
|
|
195
195
|
<b>{{ lang.t("DEFAULT:") }}</b>
|
|
196
196
|
{% with expression = type_parameter.default %}
|
|
197
|
-
<code>{% include "expression"
|
|
197
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
198
198
|
{% endwith %}
|
|
199
199
|
</span>
|
|
200
200
|
{% endif %}
|
|
@@ -15,8 +15,7 @@ Context:
|
|
|
15
15
|
{{ log.debug("Rendering warns section") }}
|
|
16
16
|
{% endblock logs %}
|
|
17
17
|
|
|
18
|
-
{
|
|
19
|
-
{% import "language"|get_template as lang with context %}
|
|
18
|
+
{% import "language.html.jinja" as lang with context %}
|
|
20
19
|
{#- Language module providing the `t` translation method. -#}
|
|
21
20
|
|
|
22
21
|
{% if config.docstring_section_style == "table" %}
|
|
@@ -36,8 +35,7 @@ Context:
|
|
|
36
35
|
<td>
|
|
37
36
|
{% if warns.annotation %}
|
|
38
37
|
{% with expression = warns.annotation, backlink_type = "emitted-by" %}
|
|
39
|
-
{
|
|
40
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
38
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
41
39
|
{% endwith %}
|
|
42
40
|
{% endif %}
|
|
43
41
|
</td>
|
|
@@ -60,8 +58,7 @@ Context:
|
|
|
60
58
|
<li class="doc-section-item field-body">
|
|
61
59
|
{% if warns.annotation %}
|
|
62
60
|
{% with expression = warns.annotation, backlink_type = "emitted-by" %}
|
|
63
|
-
{
|
|
64
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
61
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
65
62
|
{% endwith %}
|
|
66
63
|
–
|
|
67
64
|
{% endif %}
|
|
@@ -88,8 +85,7 @@ Context:
|
|
|
88
85
|
<td>
|
|
89
86
|
<span class="doc-warns-annotation">
|
|
90
87
|
{% with expression = warns.annotation, backlink_type = "emitted-by" %}
|
|
91
|
-
{
|
|
92
|
-
<code>{% include "expression"|get_template with context %}</code>
|
|
88
|
+
<code>{% include "expression.html.jinja" with context %}</code>
|
|
93
89
|
{% endwith %}
|
|
94
90
|
</span>
|
|
95
91
|
</td>
|