mkdocstrings-python 1.16.2__py3-none-any.whl → 1.16.4__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/config.py +1 -1
- mkdocstrings_handlers/python/handler.py +1 -3
- mkdocstrings_handlers/python/rendering.py +2 -2
- mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja +14 -12
- mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja +14 -12
- mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja +14 -12
- mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja +14 -12
- {mkdocstrings_python-1.16.2.dist-info → mkdocstrings_python-1.16.4.dist-info}/METADATA +2 -2
- {mkdocstrings_python-1.16.2.dist-info → mkdocstrings_python-1.16.4.dist-info}/RECORD +12 -12
- {mkdocstrings_python-1.16.2.dist-info → mkdocstrings_python-1.16.4.dist-info}/WHEEL +0 -0
- {mkdocstrings_python-1.16.2.dist-info → mkdocstrings_python-1.16.4.dist-info}/entry_points.txt +0 -0
- {mkdocstrings_python-1.16.2.dist-info → mkdocstrings_python-1.16.4.dist-info}/licenses/LICENSE +0 -0
|
@@ -7,7 +7,7 @@ import sys
|
|
|
7
7
|
from dataclasses import field, fields
|
|
8
8
|
from typing import TYPE_CHECKING, Annotated, Any, Literal
|
|
9
9
|
|
|
10
|
-
from mkdocstrings
|
|
10
|
+
from mkdocstrings import get_logger
|
|
11
11
|
|
|
12
12
|
# YORE: EOL 3.10: Replace block with line 2.
|
|
13
13
|
if sys.version_info >= (3, 11):
|
|
@@ -22,9 +22,7 @@ from griffe import (
|
|
|
22
22
|
patch_loggers,
|
|
23
23
|
)
|
|
24
24
|
from mkdocs.exceptions import PluginError
|
|
25
|
-
from mkdocstrings
|
|
26
|
-
from mkdocstrings.inventory import Inventory
|
|
27
|
-
from mkdocstrings.loggers import get_logger
|
|
25
|
+
from mkdocstrings import BaseHandler, CollectionError, CollectorItem, HandlerOptions, Inventory, get_logger
|
|
28
26
|
|
|
29
27
|
from mkdocstrings_handlers.python import rendering
|
|
30
28
|
from mkdocstrings_handlers.python.config import PythonConfig, PythonOptions
|
|
@@ -29,7 +29,7 @@ from griffe import (
|
|
|
29
29
|
from jinja2 import TemplateNotFound, pass_context, pass_environment
|
|
30
30
|
from markupsafe import Markup
|
|
31
31
|
from mkdocs_autorefs import AutorefsHookInterface
|
|
32
|
-
from mkdocstrings
|
|
32
|
+
from mkdocstrings import get_logger
|
|
33
33
|
|
|
34
34
|
if TYPE_CHECKING:
|
|
35
35
|
from collections.abc import Iterator, Sequence
|
|
@@ -37,7 +37,7 @@ if TYPE_CHECKING:
|
|
|
37
37
|
from griffe import Attribute, Class, Function, Module
|
|
38
38
|
from jinja2 import Environment, Template
|
|
39
39
|
from jinja2.runtime import Context
|
|
40
|
-
from mkdocstrings
|
|
40
|
+
from mkdocstrings import CollectorItem
|
|
41
41
|
|
|
42
42
|
logger = get_logger(__name__)
|
|
43
43
|
|
|
@@ -7,15 +7,17 @@
|
|
|
7
7
|
-#}
|
|
8
8
|
{% endblock logs %}
|
|
9
9
|
|
|
10
|
-
{%
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
{%
|
|
10
|
+
{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "attributes") | list %}
|
|
11
|
+
{% with section = obj.attributes
|
|
12
|
+
|filter_objects(
|
|
13
|
+
filters=config.filters,
|
|
14
|
+
members_list=members_list,
|
|
15
|
+
inherited_members=config.inherited_members,
|
|
16
|
+
keep_no_docstrings=config.show_if_no_docstring,
|
|
17
|
+
)
|
|
18
|
+
|order_members(config.members_order, members_list)
|
|
19
|
+
|as_attributes_section(check_public=not members_list)
|
|
20
|
+
%}
|
|
21
|
+
{% if section %}{% include "docstring/attributes"|get_template with context %}{% endif %}
|
|
22
|
+
{% endwith %}
|
|
23
|
+
{% endif %}
|
|
@@ -7,15 +7,17 @@
|
|
|
7
7
|
-#}
|
|
8
8
|
{% endblock logs %}
|
|
9
9
|
|
|
10
|
-
{%
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
{%
|
|
10
|
+
{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "classes") | list %}
|
|
11
|
+
{% with section = obj.classes
|
|
12
|
+
|filter_objects(
|
|
13
|
+
filters=config.filters,
|
|
14
|
+
members_list=members_list,
|
|
15
|
+
inherited_members=config.inherited_members,
|
|
16
|
+
keep_no_docstrings=config.show_if_no_docstring,
|
|
17
|
+
)
|
|
18
|
+
|order_members(config.members_order, members_list)
|
|
19
|
+
|as_classes_section(check_public=not members_list)
|
|
20
|
+
%}
|
|
21
|
+
{% if section %}{% include "docstring/classes"|get_template with context %}{% endif %}
|
|
22
|
+
{% endwith %}
|
|
23
|
+
{% endif %}
|
|
@@ -7,15 +7,17 @@
|
|
|
7
7
|
-#}
|
|
8
8
|
{% endblock logs %}
|
|
9
9
|
|
|
10
|
-
{%
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
{%
|
|
10
|
+
{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "functions") | list %}
|
|
11
|
+
{% with section = obj.functions
|
|
12
|
+
|filter_objects(
|
|
13
|
+
filters=config.filters,
|
|
14
|
+
members_list=members_list,
|
|
15
|
+
inherited_members=config.inherited_members,
|
|
16
|
+
keep_no_docstrings=config.show_if_no_docstring,
|
|
17
|
+
)
|
|
18
|
+
|order_members(config.members_order, members_list)
|
|
19
|
+
|as_functions_section(check_public=not members_list)
|
|
20
|
+
%}
|
|
21
|
+
{% if section %}{% include "docstring/functions"|get_template with context %}{% endif %}
|
|
22
|
+
{% endwith %}
|
|
23
|
+
{% endif %}
|
|
@@ -7,15 +7,17 @@
|
|
|
7
7
|
-#}
|
|
8
8
|
{% endblock logs %}
|
|
9
9
|
|
|
10
|
-
{%
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
{%
|
|
10
|
+
{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "modules") | list %}
|
|
11
|
+
{% with section = obj.modules
|
|
12
|
+
|filter_objects(
|
|
13
|
+
filters=config.filters,
|
|
14
|
+
members_list=members_list,
|
|
15
|
+
inherited_members=config.inherited_members,
|
|
16
|
+
keep_no_docstrings=config.show_if_no_docstring,
|
|
17
|
+
)
|
|
18
|
+
|order_members("alphabetical", members_list)
|
|
19
|
+
|as_modules_section(check_public=not members_list)
|
|
20
|
+
%}
|
|
21
|
+
{% if section %}{% include "docstring/modules"|get_template with context %}{% endif %}
|
|
22
|
+
{% endwith %}
|
|
23
|
+
{% endif %}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.1
|
|
2
2
|
Name: mkdocstrings-python
|
|
3
|
-
Version: 1.16.
|
|
3
|
+
Version: 1.16.4
|
|
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: ISC
|
|
@@ -29,7 +29,7 @@ Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
|
|
|
29
29
|
Project-URL: Gitter, https://gitter.im/mkdocstrings/python
|
|
30
30
|
Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
31
31
|
Requires-Python: >=3.9
|
|
32
|
-
Requires-Dist: mkdocstrings>=0.28.
|
|
32
|
+
Requires-Dist: mkdocstrings>=0.28.3
|
|
33
33
|
Requires-Dist: mkdocs-autorefs>=1.4
|
|
34
34
|
Requires-Dist: griffe>=0.49
|
|
35
35
|
Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
|
|
@@ -148,11 +148,11 @@ mkdocstrings_handlers/python/.mypy_cache/3.12/watchdog/observers/polling.data.js
|
|
|
148
148
|
mkdocstrings_handlers/python/.mypy_cache/3.12/watchdog/observers/polling.meta.json,sha256=EDv6SusmmK9nmVtgCfInvJ8BlI91GDkqFeYVkybpql0,1941
|
|
149
149
|
mkdocstrings_handlers/python/.mypy_cache/CACHEDIR.TAG,sha256=8cE6_FVTWMkDOw8fMKqhd_6IvaQPS4okWYQA1UeHatw,190
|
|
150
150
|
mkdocstrings_handlers/python/__init__.py,sha256=k-0NWvXysr5RqWjtGyCozookveBB-ADZHIhgxvI1px8,128
|
|
151
|
-
mkdocstrings_handlers/python/config.py,sha256=
|
|
151
|
+
mkdocstrings_handlers/python/config.py,sha256=YUOP_DTPfvzYDeEweRePjSYE2TAD6HenNf1tifJXN2o,31639
|
|
152
152
|
mkdocstrings_handlers/python/debug.py,sha256=4vqIbCbbz_vcjcFk6jPoF8E1kLig8AQEsQ93ybcjIVc,2894
|
|
153
|
-
mkdocstrings_handlers/python/handler.py,sha256=
|
|
153
|
+
mkdocstrings_handlers/python/handler.py,sha256=DBYjKnbh0oe8muN8PU5zrhNNEuqk40lIjXX977_cnho,14860
|
|
154
154
|
mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
155
|
-
mkdocstrings_handlers/python/rendering.py,sha256=
|
|
155
|
+
mkdocstrings_handlers/python/rendering.py,sha256=zqJ5E9oSLDw4NJHAl1fngBZIzd5heCqo-WtctakBIfw,23021
|
|
156
156
|
mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=nn0671f4bE7VqnTs-VQL3SGPACWAxb2uJBRcP2nwYng,427
|
|
157
157
|
mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=sbbkQtl5bPm5mmmZ-VCyLtfsOuhSr-FrD2FUSlbK-Zs,4451
|
|
158
158
|
mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=mOafkSlphFQJLWfrYrIMFVRGi2yjdtN6iJh8bPt7uRI,424
|
|
@@ -208,13 +208,13 @@ mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja,sha25
|
|
|
208
208
|
mkdocstrings_handlers/python/templates/material/_base/summary.html,sha256=2OR2p8zJ5I0mkknX7ZY7qj59orJH4e9HVg0S5DaUUsU,421
|
|
209
209
|
mkdocstrings_handlers/python/templates/material/_base/summary.html.jinja,sha256=s5rEtPwncirxmPmF-F9LsFBhAay_HEQtHf7cDjh-WnM,730
|
|
210
210
|
mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html,sha256=CSrl1A7woDmRxgMpYHArnKQGgilSbk8fvXgsx1OzPwU,454
|
|
211
|
-
mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja,sha256=
|
|
211
|
+
mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja,sha256=1QcvqHWt1OV-XXmCLBrLKPsi1QXy8I75eXkbaI41LgY,765
|
|
212
212
|
mkdocstrings_handlers/python/templates/material/_base/summary/classes.html,sha256=hhFsCc_4quq7mPWMWKBMas1jNRjSOHoCmbz8gGR1by8,445
|
|
213
|
-
mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja,sha256=
|
|
213
|
+
mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja,sha256=f2JGctWSljUNZ9I6L_syIcdVrEDeUfs7sBZVTLLldHI,750
|
|
214
214
|
mkdocstrings_handlers/python/templates/material/_base/summary/functions.html,sha256=gm2x5_dy7KVWxBSZlY7gCjXyC0otT6n0pIpxTvjp8WA,451
|
|
215
|
-
mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja,sha256=
|
|
215
|
+
mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja,sha256=OJVwHFwyk2_HHaYi0oIQCKU5zRx2eMi608YdfMPnt9U,768
|
|
216
216
|
mkdocstrings_handlers/python/templates/material/_base/summary/modules.html,sha256=4aM17FMv-a-h5IawwFtxDHw2AdI6fICyiKtdYckQc6s,445
|
|
217
|
-
mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja,sha256=
|
|
217
|
+
mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja,sha256=WqWyIx8yEenQZGYuq2NLiH_mFqs8bTRCDlM9JS2c3zs,744
|
|
218
218
|
mkdocstrings_handlers/python/templates/material/attribute.html,sha256=HkKz308jpCZj3PffJ5JtZC46rtkNNZ-2bE5zvaQQTRE,43
|
|
219
219
|
mkdocstrings_handlers/python/templates/material/attribute.html.jinja,sha256=HkKz308jpCZj3PffJ5JtZC46rtkNNZ-2bE5zvaQQTRE,43
|
|
220
220
|
mkdocstrings_handlers/python/templates/material/children.html,sha256=rUBgwytUT2xB9S1pCHy74o-UyLOIu-fczvj-DoMxbbA,42
|
|
@@ -327,8 +327,8 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha25
|
|
|
327
327
|
mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
|
|
328
328
|
mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
|
|
329
329
|
mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
|
|
330
|
-
mkdocstrings_python-1.16.
|
|
331
|
-
mkdocstrings_python-1.16.
|
|
332
|
-
mkdocstrings_python-1.16.
|
|
333
|
-
mkdocstrings_python-1.16.
|
|
334
|
-
mkdocstrings_python-1.16.
|
|
330
|
+
mkdocstrings_python-1.16.4.dist-info/METADATA,sha256=CS0Xw88wdcooRIlAIEbrO2IFRHdJtO5Kiv3MlPRvUpY,5572
|
|
331
|
+
mkdocstrings_python-1.16.4.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
|
|
332
|
+
mkdocstrings_python-1.16.4.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
|
|
333
|
+
mkdocstrings_python-1.16.4.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
|
|
334
|
+
mkdocstrings_python-1.16.4.dist-info/RECORD,,
|
|
File without changes
|
{mkdocstrings_python-1.16.2.dist-info → mkdocstrings_python-1.16.4.dist-info}/entry_points.txt
RENAMED
|
File without changes
|
{mkdocstrings_python-1.16.2.dist-info → mkdocstrings_python-1.16.4.dist-info}/licenses/LICENSE
RENAMED
|
File without changes
|