mkdocstrings-python 1.16.12__py3-none-any.whl → 1.17.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/_internal/config.py +90 -1
- mkdocstrings_handlers/python/_internal/handler.py +7 -4
- mkdocstrings_handlers/python/_internal/rendering.py +6 -5
- mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja +4 -2
- mkdocstrings_handlers/python/templates/material/_base/children.html.jinja +4 -4
- mkdocstrings_handlers/python/templates/material/_base/class.html.jinja +2 -0
- mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja +3 -0
- mkdocstrings_handlers/python/templates/material/_base/function.html.jinja +3 -1
- mkdocstrings_handlers/python/templates/material/_base/module.html.jinja +2 -0
- {mkdocstrings_python-1.16.12.dist-info → mkdocstrings_python-1.17.0.dist-info}/METADATA +3 -3
- {mkdocstrings_python-1.16.12.dist-info → mkdocstrings_python-1.17.0.dist-info}/RECORD +14 -14
- {mkdocstrings_python-1.16.12.dist-info → mkdocstrings_python-1.17.0.dist-info}/WHEEL +1 -1
- {mkdocstrings_python-1.16.12.dist-info → mkdocstrings_python-1.17.0.dist-info}/entry_points.txt +0 -0
- {mkdocstrings_python-1.16.12.dist-info → mkdocstrings_python-1.17.0.dist-info}/licenses/LICENSE +0 -0
|
@@ -186,6 +186,24 @@ class GoogleStyleOptions:
|
|
|
186
186
|
),
|
|
187
187
|
] = True
|
|
188
188
|
|
|
189
|
+
warn_missing_types: Annotated[
|
|
190
|
+
bool,
|
|
191
|
+
_Field(
|
|
192
|
+
group="docstrings",
|
|
193
|
+
parent="docstring_options",
|
|
194
|
+
description="Warn about missing type/annotation for parameters, return values, etc.",
|
|
195
|
+
),
|
|
196
|
+
] = True
|
|
197
|
+
|
|
198
|
+
warnings: Annotated[
|
|
199
|
+
bool,
|
|
200
|
+
_Field(
|
|
201
|
+
group="docstrings",
|
|
202
|
+
parent="docstring_options",
|
|
203
|
+
description="Generally enable/disable warnings when parsing docstrings.",
|
|
204
|
+
),
|
|
205
|
+
] = True
|
|
206
|
+
|
|
189
207
|
|
|
190
208
|
# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
|
|
191
209
|
@dataclass(**_dataclass_options) # type: ignore[call-overload]
|
|
@@ -219,12 +237,57 @@ class NumpyStyleOptions:
|
|
|
219
237
|
),
|
|
220
238
|
] = True
|
|
221
239
|
|
|
240
|
+
warn_missing_types: Annotated[
|
|
241
|
+
bool,
|
|
242
|
+
_Field(
|
|
243
|
+
group="docstrings",
|
|
244
|
+
parent="docstring_options",
|
|
245
|
+
description="Warn about missing type/annotation for parameters, return values, etc.",
|
|
246
|
+
),
|
|
247
|
+
] = True
|
|
248
|
+
|
|
249
|
+
warnings: Annotated[
|
|
250
|
+
bool,
|
|
251
|
+
_Field(
|
|
252
|
+
group="docstrings",
|
|
253
|
+
parent="docstring_options",
|
|
254
|
+
description="Generally enable/disable warnings when parsing docstrings.",
|
|
255
|
+
),
|
|
256
|
+
] = True
|
|
257
|
+
|
|
222
258
|
|
|
223
259
|
# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
|
|
224
260
|
@dataclass(**_dataclass_options) # type: ignore[call-overload]
|
|
225
261
|
class SphinxStyleOptions:
|
|
226
262
|
"""Sphinx style docstring options."""
|
|
227
263
|
|
|
264
|
+
warn_unknown_params: Annotated[
|
|
265
|
+
bool,
|
|
266
|
+
_Field(
|
|
267
|
+
group="docstrings",
|
|
268
|
+
parent="docstring_options",
|
|
269
|
+
description="Warn about documented parameters not appearing in the signature.",
|
|
270
|
+
),
|
|
271
|
+
] = True
|
|
272
|
+
|
|
273
|
+
warn_missing_types: Annotated[
|
|
274
|
+
bool,
|
|
275
|
+
_Field(
|
|
276
|
+
group="docstrings",
|
|
277
|
+
parent="docstring_options",
|
|
278
|
+
description="Warn about missing type/annotation for return values.",
|
|
279
|
+
),
|
|
280
|
+
] = True
|
|
281
|
+
|
|
282
|
+
warnings: Annotated[
|
|
283
|
+
bool,
|
|
284
|
+
_Field(
|
|
285
|
+
group="docstrings",
|
|
286
|
+
parent="docstring_options",
|
|
287
|
+
description="Generally enable/disable warnings when parsing docstrings.",
|
|
288
|
+
),
|
|
289
|
+
] = True
|
|
290
|
+
|
|
228
291
|
|
|
229
292
|
# YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.
|
|
230
293
|
@dataclass(**_dataclass_options) # type: ignore[call-overload]
|
|
@@ -554,6 +617,14 @@ class PythonInputOptions:
|
|
|
554
617
|
),
|
|
555
618
|
] = False
|
|
556
619
|
|
|
620
|
+
overloads_only: Annotated[
|
|
621
|
+
bool,
|
|
622
|
+
_Field(
|
|
623
|
+
group="signatures",
|
|
624
|
+
description="Whether to hide the implementation signature if the overloads are shown.",
|
|
625
|
+
),
|
|
626
|
+
] = False
|
|
627
|
+
|
|
557
628
|
parameter_headings: Annotated[
|
|
558
629
|
bool,
|
|
559
630
|
_Field(
|
|
@@ -614,6 +685,14 @@ class PythonInputOptions:
|
|
|
614
685
|
),
|
|
615
686
|
] = False
|
|
616
687
|
|
|
688
|
+
show_attribute_values: Annotated[
|
|
689
|
+
bool,
|
|
690
|
+
_Field(
|
|
691
|
+
group="signatures",
|
|
692
|
+
description="Show initial values of attributes in classes.",
|
|
693
|
+
),
|
|
694
|
+
] = True
|
|
695
|
+
|
|
617
696
|
show_bases: Annotated[
|
|
618
697
|
bool,
|
|
619
698
|
_Field(
|
|
@@ -849,6 +928,14 @@ class PythonInputOptions:
|
|
|
849
928
|
),
|
|
850
929
|
] = False
|
|
851
930
|
|
|
931
|
+
skip_local_inventory: Annotated[
|
|
932
|
+
bool,
|
|
933
|
+
_Field(
|
|
934
|
+
group="general",
|
|
935
|
+
description="Whether to prevent objects from being registered in the local objects inventory.",
|
|
936
|
+
),
|
|
937
|
+
] = False
|
|
938
|
+
|
|
852
939
|
signature_crossrefs: Annotated[
|
|
853
940
|
bool,
|
|
854
941
|
_Field(
|
|
@@ -1019,7 +1106,9 @@ class PythonInputConfig:
|
|
|
1019
1106
|
|
|
1020
1107
|
locale: Annotated[
|
|
1021
1108
|
str | None,
|
|
1022
|
-
_Field(
|
|
1109
|
+
_Field(
|
|
1110
|
+
description="Deprecated. Use mkdocstrings' own `locale` setting instead. The locale to use when translating template strings.",
|
|
1111
|
+
),
|
|
1023
1112
|
] = None
|
|
1024
1113
|
|
|
1025
1114
|
@classmethod
|
|
@@ -278,12 +278,13 @@ class PythonHandler(BaseHandler):
|
|
|
278
278
|
|
|
279
279
|
return doc_object
|
|
280
280
|
|
|
281
|
-
def render(self, data: CollectorItem, options: PythonOptions) -> str:
|
|
281
|
+
def render(self, data: CollectorItem, options: PythonOptions, locale: str | None = None) -> str:
|
|
282
282
|
"""Render the collected data.
|
|
283
283
|
|
|
284
284
|
Parameters:
|
|
285
285
|
data: The collected data.
|
|
286
286
|
options: The options to use for rendering.
|
|
287
|
+
locale: The locale to use for rendering (default is "en").
|
|
287
288
|
|
|
288
289
|
Returns:
|
|
289
290
|
The rendered data (HTML).
|
|
@@ -300,7 +301,8 @@ class PythonHandler(BaseHandler):
|
|
|
300
301
|
# than as an item in a dictionary.
|
|
301
302
|
"heading_level": options.heading_level,
|
|
302
303
|
"root": True,
|
|
303
|
-
"
|
|
304
|
+
# YORE: Bump 2: Regex-replace ` or .+` with ` or "en",` within line.
|
|
305
|
+
"locale": locale or self.config.locale,
|
|
304
306
|
},
|
|
305
307
|
)
|
|
306
308
|
|
|
@@ -360,7 +362,7 @@ class PythonHandler(BaseHandler):
|
|
|
360
362
|
return tuple(f"{alias}({parameter})" for alias in aliases)
|
|
361
363
|
return tuple(aliases)
|
|
362
364
|
|
|
363
|
-
def normalize_extension_paths(self, extensions: Sequence) ->
|
|
365
|
+
def normalize_extension_paths(self, extensions: Sequence) -> list[str | dict[str, Any]]:
|
|
364
366
|
"""Resolve extension paths relative to config file.
|
|
365
367
|
|
|
366
368
|
Parameters:
|
|
@@ -369,7 +371,7 @@ class PythonHandler(BaseHandler):
|
|
|
369
371
|
Returns:
|
|
370
372
|
The normalized extensions.
|
|
371
373
|
"""
|
|
372
|
-
normalized = []
|
|
374
|
+
normalized: list[str | dict[str, Any]] = []
|
|
373
375
|
|
|
374
376
|
for ext in extensions:
|
|
375
377
|
if isinstance(ext, dict):
|
|
@@ -401,6 +403,7 @@ def get_handler(
|
|
|
401
403
|
Parameters:
|
|
402
404
|
handler_config: The handler configuration.
|
|
403
405
|
tool_config: The tool (SSG) configuration.
|
|
406
|
+
**kwargs: Additional arguments to pass to the handler.
|
|
404
407
|
|
|
405
408
|
Returns:
|
|
406
409
|
An instance of `PythonHandler`.
|
|
@@ -208,6 +208,7 @@ def do_format_attribute(
|
|
|
208
208
|
line_length: int,
|
|
209
209
|
*,
|
|
210
210
|
crossrefs: bool = False, # noqa: ARG001
|
|
211
|
+
show_value: bool = True,
|
|
211
212
|
) -> str:
|
|
212
213
|
"""Format an attribute.
|
|
213
214
|
|
|
@@ -235,7 +236,7 @@ def do_format_attribute(
|
|
|
235
236
|
backlink_type="returned-by",
|
|
236
237
|
)
|
|
237
238
|
signature += f": {annotation}"
|
|
238
|
-
if attribute.value:
|
|
239
|
+
if show_value and attribute.value:
|
|
239
240
|
value = template.render(context.parent, expression=attribute.value, signature=True, backlink_type="used-by")
|
|
240
241
|
signature += f" = {value}"
|
|
241
242
|
|
|
@@ -261,7 +262,7 @@ def do_format_attribute(
|
|
|
261
262
|
def do_order_members(
|
|
262
263
|
members: Sequence[Object | Alias],
|
|
263
264
|
order: Order | list[Order],
|
|
264
|
-
members_list: bool | list[str] | None,
|
|
265
|
+
members_list: bool | list[str] | None, # noqa: FBT001
|
|
265
266
|
) -> Sequence[Object | Alias]:
|
|
266
267
|
"""Order members given an ordering method.
|
|
267
268
|
|
|
@@ -522,7 +523,7 @@ def _get_formatter() -> Callable[[str, int], str]:
|
|
|
522
523
|
|
|
523
524
|
def _get_ruff_formatter() -> Callable[[str, int], str] | None:
|
|
524
525
|
try:
|
|
525
|
-
from ruff.__main__ import find_ruff_bin
|
|
526
|
+
from ruff.__main__ import find_ruff_bin # noqa: PLC0415
|
|
526
527
|
except ImportError:
|
|
527
528
|
return None
|
|
528
529
|
|
|
@@ -558,7 +559,7 @@ def _get_ruff_formatter() -> Callable[[str, int], str] | None:
|
|
|
558
559
|
|
|
559
560
|
def _get_black_formatter() -> Callable[[str, int], str] | None:
|
|
560
561
|
try:
|
|
561
|
-
from black import InvalidInput, Mode, format_str
|
|
562
|
+
from black import InvalidInput, Mode, format_str # noqa: PLC0415
|
|
562
563
|
except ModuleNotFoundError:
|
|
563
564
|
return None
|
|
564
565
|
|
|
@@ -638,7 +639,7 @@ def do_as_attributes_section(
|
|
|
638
639
|
name=attribute.name,
|
|
639
640
|
description=_parse_docstring_summary(attribute),
|
|
640
641
|
annotation=attribute.annotation,
|
|
641
|
-
value=attribute.value,
|
|
642
|
+
value=attribute.value,
|
|
642
643
|
)
|
|
643
644
|
for attribute in attributes
|
|
644
645
|
if not check_public or attribute.is_public
|
|
@@ -40,6 +40,7 @@ Context:
|
|
|
40
40
|
id=html_id,
|
|
41
41
|
class="doc doc-heading",
|
|
42
42
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> '|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute.name),
|
|
43
|
+
skip_inventory=config.skip_local_inventory,
|
|
43
44
|
) %}
|
|
44
45
|
|
|
45
46
|
{% block heading scoped %}
|
|
@@ -55,7 +56,7 @@ Context:
|
|
|
55
56
|
{% else %}
|
|
56
57
|
{%+ filter highlight(language="python", inline=True) %}
|
|
57
58
|
{{ attribute_name }}{% if attribute.annotation and config.show_signature_annotations %}: {{ attribute.annotation }}{% endif %}
|
|
58
|
-
{% if attribute.value %} = {{ attribute.value }}{% endif %}
|
|
59
|
+
{% if config.show_attribute_values and attribute.value %} = {{ attribute.value }}{% endif %}
|
|
59
60
|
{% endfilter %}
|
|
60
61
|
{% endif %}
|
|
61
62
|
{% endblock heading %}
|
|
@@ -79,7 +80,7 @@ Context:
|
|
|
79
80
|
This block renders the signature for the attribute.
|
|
80
81
|
-#}
|
|
81
82
|
{% if config.separate_signature %}
|
|
82
|
-
{% filter format_attribute(attribute, config.line_length, crossrefs=config.signature_crossrefs) %}
|
|
83
|
+
{% filter format_attribute(attribute, config.line_length, crossrefs=config.signature_crossrefs, show_value=config.show_attribute_values) %}
|
|
83
84
|
{{ attribute.name }}
|
|
84
85
|
{% endfilter %}
|
|
85
86
|
{% endif %}
|
|
@@ -93,6 +94,7 @@ Context:
|
|
|
93
94
|
id=html_id,
|
|
94
95
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code> '|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute_name),
|
|
95
96
|
hidden=True,
|
|
97
|
+
skip_inventory=config.skip_local_inventory,
|
|
96
98
|
) %}
|
|
97
99
|
{% endfilter %}
|
|
98
100
|
{% endif %}
|
|
@@ -45,7 +45,7 @@ Context:
|
|
|
45
45
|
) %}
|
|
46
46
|
{% if attributes %}
|
|
47
47
|
{% if config.show_category_heading %}
|
|
48
|
-
{% filter heading(heading_level, id=html_id ~ "-attributes") %}Attributes{% endfilter %}
|
|
48
|
+
{% filter heading(heading_level, id=html_id ~ "-attributes", skip_inventory=config.skip_local_inventory) %}Attributes{% endfilter %}
|
|
49
49
|
{% endif %}
|
|
50
50
|
{% with heading_level = heading_level + extra_level %}
|
|
51
51
|
{% for attribute in attributes|order_members(config.members_order, members_list) %}
|
|
@@ -65,7 +65,7 @@ Context:
|
|
|
65
65
|
) %}
|
|
66
66
|
{% if classes %}
|
|
67
67
|
{% if config.show_category_heading %}
|
|
68
|
-
{% filter heading(heading_level, id=html_id ~ "-classes") %}Classes{% endfilter %}
|
|
68
|
+
{% filter heading(heading_level, id=html_id ~ "-classes", skip_inventory=config.skip_local_inventory) %}Classes{% endfilter %}
|
|
69
69
|
{% endif %}
|
|
70
70
|
{% with heading_level = heading_level + extra_level %}
|
|
71
71
|
{% for class in classes|order_members(config.members_order, members_list) %}
|
|
@@ -85,7 +85,7 @@ Context:
|
|
|
85
85
|
) %}
|
|
86
86
|
{% if functions %}
|
|
87
87
|
{% if config.show_category_heading %}
|
|
88
|
-
{% filter heading(heading_level, id=html_id ~ "-functions") %}Functions{% endfilter %}
|
|
88
|
+
{% filter heading(heading_level, id=html_id ~ "-functions", skip_inventory=config.skip_local_inventory) %}Functions{% endfilter %}
|
|
89
89
|
{% endif %}
|
|
90
90
|
{% with heading_level = heading_level + extra_level %}
|
|
91
91
|
{% for function in functions|order_members(config.members_order, members_list) %}
|
|
@@ -108,7 +108,7 @@ Context:
|
|
|
108
108
|
) %}
|
|
109
109
|
{% if modules %}
|
|
110
110
|
{% if config.show_category_heading %}
|
|
111
|
-
{% filter heading(heading_level, id=html_id ~ "-modules") %}Modules{% endfilter %}
|
|
111
|
+
{% filter heading(heading_level, id=html_id ~ "-modules", skip_inventory=config.skip_local_inventory) %}Modules{% endfilter %}
|
|
112
112
|
{% endif %}
|
|
113
113
|
{% with heading_level = heading_level + extra_level %}
|
|
114
114
|
{% for module in modules|order_members("alphabetical", members_list) %}
|
|
@@ -39,6 +39,7 @@ Context:
|
|
|
39
39
|
id=html_id,
|
|
40
40
|
class="doc doc-heading",
|
|
41
41
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> '|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else class.name),
|
|
42
|
+
skip_inventory=config.skip_local_inventory,
|
|
42
43
|
) %}
|
|
43
44
|
|
|
44
45
|
{% block heading scoped %}
|
|
@@ -112,6 +113,7 @@ Context:
|
|
|
112
113
|
id=html_id,
|
|
113
114
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-class"></code> '|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else class.name),
|
|
114
115
|
hidden=True,
|
|
116
|
+
skip_inventory=config.skip_local_inventory,
|
|
115
117
|
) %}
|
|
116
118
|
{% endfilter %}
|
|
117
119
|
{% endif %}
|
|
@@ -43,6 +43,7 @@ Context:
|
|
|
43
43
|
id=html_id ~ "(" ~ parameter.name ~ ")",
|
|
44
44
|
class="doc doc-heading doc-heading-parameter",
|
|
45
45
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code> '|safe if config.show_symbol_type_toc else '') + parameter.name,
|
|
46
|
+
skip_inventory=config.skip_local_inventory,
|
|
46
47
|
) %}
|
|
47
48
|
<code>{{ parameter.name }}</code>
|
|
48
49
|
{% endfilter %}
|
|
@@ -92,6 +93,7 @@ Context:
|
|
|
92
93
|
id=html_id ~ "(" ~ parameter.name ~ ")",
|
|
93
94
|
class="doc doc-heading doc-heading-parameter",
|
|
94
95
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code> '|safe if config.show_symbol_type_toc else '') + parameter.name,
|
|
96
|
+
skip_inventory=config.skip_local_inventory,
|
|
95
97
|
) %}
|
|
96
98
|
<b><code>{{ parameter.name }}</code></b>
|
|
97
99
|
{% endfilter %}
|
|
@@ -139,6 +141,7 @@ Context:
|
|
|
139
141
|
id=html_id ~ "(" ~ parameter.name ~ ")",
|
|
140
142
|
class="doc doc-heading doc-heading-parameter",
|
|
141
143
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-parameter"></code> '|safe if config.show_symbol_type_toc else '') + parameter.name,
|
|
144
|
+
skip_inventory=config.skip_local_inventory,
|
|
142
145
|
) %}
|
|
143
146
|
<code>{{ parameter.name }}</code>
|
|
144
147
|
{% endfilter %}
|
|
@@ -46,6 +46,7 @@ Context:
|
|
|
46
46
|
id=html_id,
|
|
47
47
|
class="doc doc-heading",
|
|
48
48
|
toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code> ')|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else function.name),
|
|
49
|
+
skip_inventory=config.skip_local_inventory,
|
|
49
50
|
) %}
|
|
50
51
|
|
|
51
52
|
{% block heading scoped %}
|
|
@@ -94,7 +95,7 @@ Context:
|
|
|
94
95
|
{% endfor %}
|
|
95
96
|
</div>
|
|
96
97
|
{% endif %}
|
|
97
|
-
{% if config.separate_signature %}
|
|
98
|
+
{% if config.separate_signature and not (config.show_overloads and function.overloads and config.overloads_only) %}
|
|
98
99
|
{% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
|
|
99
100
|
{{ function.name }}
|
|
100
101
|
{% endfilter %}
|
|
@@ -110,6 +111,7 @@ Context:
|
|
|
110
111
|
id=html_id,
|
|
111
112
|
toc_label=(('<code class="doc-symbol doc-symbol-toc doc-symbol-' + symbol_type + '"></code> ')|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else function.name),
|
|
112
113
|
hidden=True,
|
|
114
|
+
skip_inventory=config.skip_local_inventory,
|
|
113
115
|
) %}
|
|
114
116
|
{% endfilter %}
|
|
115
117
|
{% endif %}
|
|
@@ -39,6 +39,7 @@ Context:
|
|
|
39
39
|
id=html_id,
|
|
40
40
|
class="doc doc-heading",
|
|
41
41
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> '|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else module.name),
|
|
42
|
+
skip_inventory=config.skip_local_inventory,
|
|
42
43
|
) %}
|
|
43
44
|
|
|
44
45
|
{% block heading scoped %}
|
|
@@ -76,6 +77,7 @@ Context:
|
|
|
76
77
|
id=html_id,
|
|
77
78
|
toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-module"></code> '|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else module.name),
|
|
78
79
|
hidden=True,
|
|
80
|
+
skip_inventory=config.skip_local_inventory,
|
|
79
81
|
) %}
|
|
80
82
|
{% endfilter %}
|
|
81
83
|
{% endif %}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mkdocstrings-python
|
|
3
|
-
Version: 1.
|
|
3
|
+
Version: 1.17.0
|
|
4
4
|
Summary: A Python handler for mkdocstrings.
|
|
5
5
|
Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
|
|
6
6
|
License-Expression: ISC
|
|
@@ -30,9 +30,9 @@ Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
|
|
|
30
30
|
Project-URL: Gitter, https://gitter.im/mkdocstrings/python
|
|
31
31
|
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
32
32
|
Requires-Python: >=3.9
|
|
33
|
-
Requires-Dist: mkdocstrings>=0.
|
|
33
|
+
Requires-Dist: mkdocstrings>=0.30
|
|
34
34
|
Requires-Dist: mkdocs-autorefs>=1.4
|
|
35
|
-
Requires-Dist: griffe>=1.
|
|
35
|
+
Requires-Dist: griffe>=1.12.1
|
|
36
36
|
Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
|
|
37
37
|
Description-Content-Type: text/markdown
|
|
38
38
|
|
|
@@ -1,20 +1,20 @@
|
|
|
1
1
|
mkdocstrings_handlers/python/__init__.py,sha256=lg-XSQYS-o5J9_jBU35SA7rCW54CK0JsNcrSgsCfW2k,1614
|
|
2
2
|
mkdocstrings_handlers/python/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
3
|
-
mkdocstrings_handlers/python/_internal/config.py,sha256=
|
|
3
|
+
mkdocstrings_handlers/python/_internal/config.py,sha256=D59yUmXJkhcv-I2_pFGDMHYuzQyXQK401-GGELsNb7o,35943
|
|
4
4
|
mkdocstrings_handlers/python/_internal/debug.py,sha256=KnkMM_XSjcE0-9U86AZPucS2hsCD6Rfn_BgMs7_xc3U,2845
|
|
5
|
-
mkdocstrings_handlers/python/_internal/handler.py,sha256=
|
|
6
|
-
mkdocstrings_handlers/python/_internal/rendering.py,sha256=
|
|
5
|
+
mkdocstrings_handlers/python/_internal/handler.py,sha256=mwY9B0G438boBvDGC6aWJqydLAFuYgNYR9H8vTt1zuk,16278
|
|
6
|
+
mkdocstrings_handlers/python/_internal/rendering.py,sha256=Yogt49Al0MYL33hbhYQKn2EXrekUvpLc95_Ayshrs3k,26730
|
|
7
7
|
mkdocstrings_handlers/python/config.py,sha256=gDuOF8vYwo00opwtObQ55WQq2ECynirwcaGnd0VCHg4,477
|
|
8
8
|
mkdocstrings_handlers/python/handler.py,sha256=xZnhzVC_y6ni3eX_RRO8132ED7DqXqU7IjA6sm8lCk8,480
|
|
9
9
|
mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
10
10
|
mkdocstrings_handlers/python/rendering.py,sha256=xSfGS8K1uo1raw4ChhTyZE1bxdM8NKK4uD1vCO_R4lA,486
|
|
11
11
|
mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=M_eHCPrDCC9FFzgTaOS61MqUTUK1ha85SK1kW2lQeBY,310
|
|
12
|
-
mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=
|
|
12
|
+
mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=u9DsmFR6N9QSPfjTGkP-5f36SDvsJUbHzOukebRckvI,5022
|
|
13
13
|
mkdocstrings_handlers/python/templates/material/_base/backlinks.html.jinja,sha256=FFrvIa-KH-DhT1cpc9HL0ecShR2gUVGs3VT9c1q88z8,467
|
|
14
14
|
mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=EQuTDoMRrICrieD62VZ9Ay-tw3sJQe4Jh7yDnFe1zFk,307
|
|
15
|
-
mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=
|
|
15
|
+
mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=Bc1T-0n7TOZoyaNq8fKzC5R-YFWV-v7ceC_YkXCttE0,6717
|
|
16
16
|
mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=phAElLOLdaCRMW7uv1G5ePW3deavBpCp29OsK2Njn6E,298
|
|
17
|
-
mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=
|
|
17
|
+
mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=6wykrr0a_xXGbhFMjQ2XLgKFE4eLFlADjP1fZ2FeQo0,9827
|
|
18
18
|
mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=x2JcxMNtM0xc1qZv1cKJQv4svNXyFThtKLJ66YqFHAQ,310
|
|
19
19
|
mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja,sha256=q88YLwuw2KRlxQMADP14XsnzDt0UYk8nmmzKb1ECcbQ,4247
|
|
20
20
|
mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=YAwZQv3ABAtcge8-PTpi0jIAaDONE8E2sWiBSSKSl98,343
|
|
@@ -32,7 +32,7 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jin
|
|
|
32
32
|
mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html,sha256=PAvgUheHUuro00SuuOZb6aWMK0BzLzlVnJgwBR6CRwg,361
|
|
33
33
|
mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html.jinja,sha256=EVQ8ni4gW7yuuGJn2Ue1ovKlM1nW-CMav9Z5z8Xsrsk,4423
|
|
34
34
|
mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html,sha256=c98W_ObFjs_8xVTharuDi9CdfTGSxnqpVmQgJwlU0Yk,343
|
|
35
|
-
mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja,sha256=
|
|
35
|
+
mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html.jinja,sha256=0mGNwo6ofLRPZgFWuYfgIGesdDJzJrS5TlvxXCjWV48,7860
|
|
36
36
|
mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html,sha256=yr2t1-khd_-IQtFEvb29aEPYzREqK80HJFAH7FWx97s,331
|
|
37
37
|
mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html.jinja,sha256=HLkBEYwoehC-mLSlda18Pf_RAKZ40-hSRmWgYUX-tOw,4007
|
|
38
38
|
mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html,sha256=BWrxLHSth3PN4yt0PphwDm8ZfQMVHKBNHK6W3CZHvZ4,337
|
|
@@ -46,7 +46,7 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinj
|
|
|
46
46
|
mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=ngA65vQBP142R6UeOpSVDUlVLwBjfiJfYMyi7WjHH9I,313
|
|
47
47
|
mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha256=RZX2Wbmhlldvr0H8SB0hFOiHaxY7G7wnKNOhBRoJpJY,4688
|
|
48
48
|
mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=k-cXHimSwRoXuwF0H26XvdaW5mgIl9miMd7zD641oj8,307
|
|
49
|
-
mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=
|
|
49
|
+
mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=gAibzEpMb9K4m5pQTRCNPdvbnbA-HJYx9sd8K_LfMQ4,6496
|
|
50
50
|
mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=zeazKqY21Xjch_qEIXvKWI-FM6MVlNSxc0kFoQghk50,301
|
|
51
51
|
mkdocstrings_handlers/python/templates/material/_base/labels.html.jinja,sha256=mue5CMl2WQpagj3aYqbUiAQX0P72aLCgY3MX_zEpE8s,786
|
|
52
52
|
mkdocstrings_handlers/python/templates/material/_base/language.html,sha256=mLBW7Ovd7S03KPJzbvKkOLk-lvGumaQnj4VgcDjDnjc,307
|
|
@@ -58,7 +58,7 @@ mkdocstrings_handlers/python/templates/material/_base/languages/ja.html.jinja,sh
|
|
|
58
58
|
mkdocstrings_handlers/python/templates/material/_base/languages/zh.html,sha256=FzTS6G4SgdlHbhEPKqd6y2wU_ewQkPUm1_kzET6NIJ4,319
|
|
59
59
|
mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja,sha256=Zr0o9OJv_NWZ2IHZrQYUpM7U-GCnRNr9y5FVQzIHLxY,1125
|
|
60
60
|
mkdocstrings_handlers/python/templates/material/_base/module.html,sha256=lv0T7AeEMQBL6SNX85YXHH7fzlpuEe8vhE5n9Dsexhk,301
|
|
61
|
-
mkdocstrings_handlers/python/templates/material/_base/module.html.jinja,sha256=
|
|
61
|
+
mkdocstrings_handlers/python/templates/material/_base/module.html.jinja,sha256=w879FrBl_dwaAV7_q8V0yj0qaz_gjBLxA9k0B5UMa90,4789
|
|
62
62
|
mkdocstrings_handlers/python/templates/material/_base/signature.html,sha256=1GP2y9T0clgpzZBTcrat5Vj8zhANgQGfT1KU1KxXPI8,310
|
|
63
63
|
mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja,sha256=UsGg2aFf1J68SPXpWpJ3DvsTbFTSIKVeLc7V-L3JtHc,5401
|
|
64
64
|
mkdocstrings_handlers/python/templates/material/_base/summary.html,sha256=5EPKJLvlth7SlgAWjy5bRQwDmcFq5aFaUQjTm-IHt30,304
|
|
@@ -184,8 +184,8 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha25
|
|
|
184
184
|
mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=OIRkMlzFJ_wlXFzB96874tz6zn8UVFpEQX2hQJru2ug,79
|
|
185
185
|
mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
|
|
186
186
|
mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
|
|
187
|
-
mkdocstrings_python-1.
|
|
188
|
-
mkdocstrings_python-1.
|
|
189
|
-
mkdocstrings_python-1.
|
|
190
|
-
mkdocstrings_python-1.
|
|
191
|
-
mkdocstrings_python-1.
|
|
187
|
+
mkdocstrings_python-1.17.0.dist-info/METADATA,sha256=9GlvcdSXrlaToDwvlnGti9tvvC90FqpiF10pNvSGkkk,5605
|
|
188
|
+
mkdocstrings_python-1.17.0.dist-info/WHEEL,sha256=9P2ygRxDrTJz3gsagc0Z96ukrxjr-LFBGOgv3AuKlCA,90
|
|
189
|
+
mkdocstrings_python-1.17.0.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
|
|
190
|
+
mkdocstrings_python-1.17.0.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
|
|
191
|
+
mkdocstrings_python-1.17.0.dist-info/RECORD,,
|
{mkdocstrings_python-1.16.12.dist-info → mkdocstrings_python-1.17.0.dist-info}/entry_points.txt
RENAMED
|
File without changes
|
{mkdocstrings_python-1.16.12.dist-info → mkdocstrings_python-1.17.0.dist-info}/licenses/LICENSE
RENAMED
|
File without changes
|