mkdocstrings-python 2.0.2__py3-none-any.whl → 2.0.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/_internal/config.py +1 -1
- mkdocstrings_handlers/python/_internal/handler.py +1 -1
- mkdocstrings_handlers/python/_internal/rendering.py +7 -7
- mkdocstrings_handlers/python/templates/material/_base/children.html.jinja +1 -1
- {mkdocstrings_python-2.0.2.dist-info → mkdocstrings_python-2.0.4.dist-info}/METADATA +2 -3
- {mkdocstrings_python-2.0.2.dist-info → mkdocstrings_python-2.0.4.dist-info}/RECORD +9 -9
- {mkdocstrings_python-2.0.2.dist-info → mkdocstrings_python-2.0.4.dist-info}/WHEEL +1 -1
- {mkdocstrings_python-2.0.2.dist-info → mkdocstrings_python-2.0.4.dist-info}/entry_points.txt +0 -0
- {mkdocstrings_python-2.0.2.dist-info → mkdocstrings_python-2.0.4.dist-info}/licenses/LICENSE +0 -0
|
@@ -498,7 +498,7 @@ class PythonInputOptions:
|
|
|
498
498
|
those added to `__all__` or not starting with an underscore (except for special methods/attributes).
|
|
499
499
|
""",
|
|
500
500
|
),
|
|
501
|
-
] = field(default_factory=
|
|
501
|
+
] = field(default_factory=_DEFAULT_FILTERS.copy)
|
|
502
502
|
|
|
503
503
|
find_stubs_package: Annotated[
|
|
504
504
|
bool,
|
|
@@ -203,7 +203,7 @@ class PythonHandler(BaseHandler):
|
|
|
203
203
|
extensions=load_extensions(*extensions),
|
|
204
204
|
search_paths=self._paths,
|
|
205
205
|
docstring_parser=parser,
|
|
206
|
-
docstring_options=parser_options,
|
|
206
|
+
docstring_options=parser_options,
|
|
207
207
|
modules_collection=self._modules_collection,
|
|
208
208
|
lines_collection=self._lines_collection,
|
|
209
209
|
allow_inspection=options.allow_inspection,
|
|
@@ -414,15 +414,15 @@ def _keep_object(name: str, filters: Sequence[tuple[Pattern, bool]]) -> bool:
|
|
|
414
414
|
|
|
415
415
|
|
|
416
416
|
def _parents(obj: Alias) -> set[str]:
|
|
417
|
-
parent: Object | Alias = obj.parent
|
|
417
|
+
parent: Object | Alias = obj.parent
|
|
418
418
|
parents = {obj.path, parent.path}
|
|
419
419
|
if parent.is_alias:
|
|
420
|
-
parents.add(parent.final_target.path)
|
|
420
|
+
parents.add(parent.final_target.path)
|
|
421
421
|
while parent.parent:
|
|
422
422
|
parent = parent.parent
|
|
423
423
|
parents.add(parent.path)
|
|
424
424
|
if parent.is_alias:
|
|
425
|
-
parents.add(parent.final_target.path)
|
|
425
|
+
parents.add(parent.final_target.path)
|
|
426
426
|
return parents
|
|
427
427
|
|
|
428
428
|
|
|
@@ -431,7 +431,7 @@ def _remove_cycles(objects: list[Object | Alias]) -> Iterator[Object | Alias]:
|
|
|
431
431
|
for obj in objects:
|
|
432
432
|
if obj.is_alias:
|
|
433
433
|
with suppress_errors:
|
|
434
|
-
if obj.final_target.path in _parents(obj):
|
|
434
|
+
if obj.final_target.path in _parents(obj):
|
|
435
435
|
continue
|
|
436
436
|
yield obj
|
|
437
437
|
|
|
@@ -778,7 +778,7 @@ class AutorefsHook(AutorefsHookInterface):
|
|
|
778
778
|
obj = self.current_object
|
|
779
779
|
while identifier and identifier[0] == ".":
|
|
780
780
|
identifier = identifier[1:]
|
|
781
|
-
obj = obj.parent
|
|
781
|
+
obj = obj.parent
|
|
782
782
|
identifier = f"{obj.path}.{identifier}" if identifier else obj.path
|
|
783
783
|
|
|
784
784
|
# We resolve the identifier to its full path.
|
|
@@ -809,8 +809,8 @@ class AutorefsHook(AutorefsHookInterface):
|
|
|
809
809
|
}.get(self.current_object.kind.value.lower(), "obj")
|
|
810
810
|
origin = self.current_object.path
|
|
811
811
|
try:
|
|
812
|
-
filepath = self.current_object.docstring.parent.filepath
|
|
813
|
-
lineno = self.current_object.docstring.lineno or 0
|
|
812
|
+
filepath = self.current_object.docstring.parent.filepath
|
|
813
|
+
lineno = self.current_object.docstring.lineno or 0
|
|
814
814
|
except AttributeError:
|
|
815
815
|
filepath = self.current_object.filepath
|
|
816
816
|
lineno = 0
|
|
@@ -108,7 +108,7 @@ Context:
|
|
|
108
108
|
) %}
|
|
109
109
|
{% if functions %}
|
|
110
110
|
{% if config.show_category_heading %}
|
|
111
|
-
{% filter heading(heading_level, id=html_id ~ "-functions", skip_inventory=config.skip_local_inventory) %}{{ lang.t("Functions") }}{% endfilter %}
|
|
111
|
+
{% filter heading(heading_level, id=html_id ~ "-functions", skip_inventory=config.skip_local_inventory) %}{{ lang.t("Methods:") if obj.is_class else lang.t("Functions:") }}{% endfilter %}
|
|
112
112
|
{% endif %}
|
|
113
113
|
{% with heading_level = heading_level + extra_level %}
|
|
114
114
|
{% for function in functions|order_members(config.members_order, members_list) %}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mkdocstrings-python
|
|
3
|
-
Version: 2.0.
|
|
3
|
+
Version: 2.0.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-Expression: ISC
|
|
@@ -31,7 +31,7 @@ Project-URL: Funding, https://github.com/sponsors/pawamoy
|
|
|
31
31
|
Requires-Python: >=3.10
|
|
32
32
|
Requires-Dist: mkdocstrings>=0.30
|
|
33
33
|
Requires-Dist: mkdocs-autorefs>=1.4
|
|
34
|
-
Requires-Dist:
|
|
34
|
+
Requires-Dist: griffelib>=2.0
|
|
35
35
|
Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
|
|
36
36
|
Description-Content-Type: text/markdown
|
|
37
37
|
|
|
@@ -123,7 +123,6 @@ dependencies = [
|
|
|
123
123
|
|
|
124
124
|
<div id="silver-sponsors"><b>Silver sponsors</b><p>
|
|
125
125
|
<a href="https://fastapi.tiangolo.com/"><img alt="FastAPI" src="https://raw.githubusercontent.com/tiangolo/fastapi/master/docs/en/docs/img/logo-margin/logo-teal.png" style="height: 200px; "></a><br>
|
|
126
|
-
<a href="https://docs.pydantic.dev/latest/"><img alt="Pydantic" src="https://pydantic.dev/assets/for-external/pydantic_logfire_logo_endorsed_lithium_rgb.svg" style="height: 180px; "></a><br>
|
|
127
126
|
</p></div>
|
|
128
127
|
|
|
129
128
|
<div id="bronze-sponsors"><b>Bronze sponsors</b><p>
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
mkdocstrings_handlers/python/__init__.py,sha256=Kxy1zA4JJy0aWxUa2_xl5PfYV2-mrBKJ9Re56dq3s94,1650
|
|
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=iSnsL-DXqWSm_0YKv-2giDxTdljxZWvDgTGkCo9GBPg,35261
|
|
4
4
|
mkdocstrings_handlers/python/_internal/debug.py,sha256=A6B3w6LWN22kYtvvbmz7vnh8Pr5hzvtrHhM3-Es8Isg,2882
|
|
5
|
-
mkdocstrings_handlers/python/_internal/handler.py,sha256=
|
|
6
|
-
mkdocstrings_handlers/python/_internal/rendering.py,sha256=
|
|
5
|
+
mkdocstrings_handlers/python/_internal/handler.py,sha256=8LET9phgBvHe-cpfo1OxqkAIFVK5dZzsYjTCWP3Ls6k,15641
|
|
6
|
+
mkdocstrings_handlers/python/_internal/rendering.py,sha256=ETPIGQ47egjUVNyiBIx8kW72UQ-_ZOYcj3bAfrKMfmc,28437
|
|
7
7
|
mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
8
8
|
mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=ajtKaGxs9-VJzPNiXbQTYTO6ADq8Ck9M9x2BfXakG0g,4838
|
|
9
9
|
mkdocstrings_handlers/python/templates/material/_base/backlinks.html.jinja,sha256=k8eX0lyQmmooaEotjYngdXO8RJldjixvZW30S5jGXOA,2109
|
|
10
|
-
mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=
|
|
10
|
+
mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=1q7RS0i6SkNriRtGX8BC2wzKhp3pPcLVSJWBEUmZOSg,8153
|
|
11
11
|
mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=Wo_g0ag5P7d3rolVRYxtJMIT2U1KC9h7rh8yQFcuprQ,12153
|
|
12
12
|
mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja,sha256=iKi-31JKoHwG7-w3S88A9YTu9kuV6-c9gwKb8bUtXuw,3440
|
|
13
13
|
mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja,sha256=VFwImgb1toxkjWqyhTNFQbyYE3d11yXI___3vpIu2u0,687
|
|
@@ -114,8 +114,8 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/en.html.jinja,sha25
|
|
|
114
114
|
mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha256=e_DPZvMvaaJm0QyjTxW8SkBEbhMXBgBiMrLJ1osAwZc,46
|
|
115
115
|
mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
|
|
116
116
|
mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
|
|
117
|
-
mkdocstrings_python-2.0.
|
|
118
|
-
mkdocstrings_python-2.0.
|
|
119
|
-
mkdocstrings_python-2.0.
|
|
120
|
-
mkdocstrings_python-2.0.
|
|
121
|
-
mkdocstrings_python-2.0.
|
|
117
|
+
mkdocstrings_python-2.0.4.dist-info/METADATA,sha256=iIVWVxzLtmn9QrqzX9eYmVShDG0yZa5nnumBT00AjRU,12759
|
|
118
|
+
mkdocstrings_python-2.0.4.dist-info/WHEEL,sha256=VP-D4TPS230sME9Z3vb3INXvo1yt0924YRm5AOsk_dE,90
|
|
119
|
+
mkdocstrings_python-2.0.4.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
|
|
120
|
+
mkdocstrings_python-2.0.4.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
|
|
121
|
+
mkdocstrings_python-2.0.4.dist-info/RECORD,,
|
{mkdocstrings_python-2.0.2.dist-info → mkdocstrings_python-2.0.4.dist-info}/entry_points.txt
RENAMED
|
File without changes
|
{mkdocstrings_python-2.0.2.dist-info → mkdocstrings_python-2.0.4.dist-info}/licenses/LICENSE
RENAMED
|
File without changes
|