mkdocstrings-python 1.16.1__py3-none-any.whl → 1.16.3__py3-none-any.whl

mkdocstrings_handlers/python/config.py

@@ -7,7 +7,7 @@ import sys
 from dataclasses import field, fields
 from typing import TYPE_CHECKING, Annotated, Any, Literal
 
-from mkdocstrings.loggers import get_logger
+from mkdocstrings import get_logger
 
 # YORE: EOL 3.10: Replace block with line 2.
 if sys.version_info >= (3, 11):

mkdocstrings_handlers/python/handler.py

@@ -22,9 +22,7 @@ from griffe import (
     patch_loggers,
 )
 from mkdocs.exceptions import PluginError
-from mkdocstrings.handlers.base import BaseHandler, CollectionError, CollectorItem, HandlerOptions
-from mkdocstrings.inventory import Inventory
-from mkdocstrings.loggers import get_logger
+from mkdocstrings import BaseHandler, CollectionError, CollectorItem, HandlerOptions, Inventory, get_logger
 
 from mkdocstrings_handlers.python import rendering
 from mkdocstrings_handlers.python.config import PythonConfig, PythonOptions

mkdocstrings_handlers/python/rendering.py

@@ -28,8 +28,8 @@ from griffe import (
 )
 from jinja2 import TemplateNotFound, pass_context, pass_environment
 from markupsafe import Markup
-from mkdocs_autorefs.references import AutorefsHookInterface
-from mkdocstrings.loggers import get_logger
+from mkdocs_autorefs import AutorefsHookInterface
+from mkdocstrings import get_logger
 
 if TYPE_CHECKING:
     from collections.abc import Iterator, Sequence
@@ -37,7 +37,7 @@ if TYPE_CHECKING:
     from griffe import Attribute, Class, Function, Module
     from jinja2 import Environment, Template
     from jinja2.runtime import Context
-    from mkdocstrings.handlers.base import CollectorItem
+    from mkdocstrings import CollectorItem
 
 logger = get_logger(__name__)
 

mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja

@@ -7,15 +7,17 @@
   -#}
 {% endblock logs %}
 
-{% with section = obj.attributes
-    |filter_objects(
-      filters=config.filters,
-      members_list=members_list,
-      inherited_members=config.inherited_members,
-      keep_no_docstrings=config.show_if_no_docstring,
-    )
-    |order_members(config.members_order, members_list)
-    |as_attributes_section(check_public=not members_list)
-  %}
-  {% if section %}{% include "docstring/attributes"|get_template with context %}{% endif %}
-{% endwith %}
+{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "attributes") %}
+  {% with section = obj.attributes
+      |filter_objects(
+        filters=config.filters,
+        members_list=members_list,
+        inherited_members=config.inherited_members,
+        keep_no_docstrings=config.show_if_no_docstring,
+      )
+      |order_members(config.members_order, members_list)
+      |as_attributes_section(check_public=not members_list)
+    %}
+    {% if section %}{% include "docstring/attributes"|get_template with context %}{% endif %}
+  {% endwith %}
+{% endif %}

mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja

@@ -7,15 +7,17 @@
   -#}
 {% endblock logs %}
 
-{% with section = obj.classes
-    |filter_objects(
-      filters=config.filters,
-      members_list=members_list,
-      inherited_members=config.inherited_members,
-      keep_no_docstrings=config.show_if_no_docstring,
-    )
-    |order_members(config.members_order, members_list)
-    |as_classes_section(check_public=not members_list)
-  %}
-  {% if section %}{% include "docstring/classes"|get_template with context %}{% endif %}
-{% endwith %}
+{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "classes") %}
+  {% with section = obj.classes
+      |filter_objects(
+        filters=config.filters,
+        members_list=members_list,
+        inherited_members=config.inherited_members,
+        keep_no_docstrings=config.show_if_no_docstring,
+      )
+      |order_members(config.members_order, members_list)
+      |as_classes_section(check_public=not members_list)
+    %}
+    {% if section %}{% include "docstring/classes"|get_template with context %}{% endif %}
+  {% endwith %}
+{% endif %}

mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja

@@ -7,15 +7,17 @@
   -#}
 {% endblock logs %}
 
-{% with section = obj.functions
-    |filter_objects(
-      filters=config.filters,
-      members_list=members_list,
-      inherited_members=config.inherited_members,
-      keep_no_docstrings=config.show_if_no_docstring,
-    )
-    |order_members(config.members_order, members_list)
-    |as_functions_section(check_public=not members_list)
-  %}
-  {% if section %}{% include "docstring/functions"|get_template with context %}{% endif %}
-{% endwith %}
+{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "functions") %}
+  {% with section = obj.functions
+      |filter_objects(
+        filters=config.filters,
+        members_list=members_list,
+        inherited_members=config.inherited_members,
+        keep_no_docstrings=config.show_if_no_docstring,
+      )
+      |order_members(config.members_order, members_list)
+      |as_functions_section(check_public=not members_list)
+    %}
+    {% if section %}{% include "docstring/functions"|get_template with context %}{% endif %}
+  {% endwith %}
+{% endif %}

mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja

@@ -7,15 +7,17 @@
   -#}
 {% endblock logs %}
 
-{% with section = obj.modules
-    |filter_objects(
-      filters=config.filters,
-      members_list=members_list,
-      inherited_members=config.inherited_members,
-      keep_no_docstrings=config.show_if_no_docstring,
-    )
-    |order_members("alphabetical", members_list)
-    |as_modules_section(check_public=not members_list)
-  %}
-  {% if section %}{% include "docstring/modules"|get_template with context %}{% endif %}
-{% endwith %}
+{% if not obj.docstring.parsed | selectattr("kind.value", "eq", "modules") %}
+  {% with section = obj.modules
+      |filter_objects(
+        filters=config.filters,
+        members_list=members_list,
+        inherited_members=config.inherited_members,
+        keep_no_docstrings=config.show_if_no_docstring,
+      )
+      |order_members("alphabetical", members_list)
+      |as_modules_section(check_public=not members_list)
+    %}
+    {% if section %}{% include "docstring/modules"|get_template with context %}{% endif %}
+  {% endwith %}
+{% endif %}

{mkdocstrings_python-1.16.1.dist-info → mkdocstrings_python-1.16.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.16.1
+Version: 1.16.3
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC
@@ -29,8 +29,8 @@ Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
 Project-URL: Gitter, https://gitter.im/mkdocstrings/python
 Project-URL: Funding, https://github.com/sponsors/pawamoy
 Requires-Python: >=3.9
-Requires-Dist: mkdocstrings>=0.28
-Requires-Dist: mkdocs-autorefs>=1.2
+Requires-Dist: mkdocstrings>=0.28.3
+Requires-Dist: mkdocs-autorefs>=1.4
 Requires-Dist: griffe>=0.49
 Requires-Dist: typing-extensions>=4.0; python_version < "3.11"
 Description-Content-Type: text/markdown

{mkdocstrings_python-1.16.1.dist-info → mkdocstrings_python-1.16.3.dist-info}/RECORD

@@ -148,11 +148,11 @@ mkdocstrings_handlers/python/.mypy_cache/3.12/watchdog/observers/polling.data.js
 mkdocstrings_handlers/python/.mypy_cache/3.12/watchdog/observers/polling.meta.json,sha256=EDv6SusmmK9nmVtgCfInvJ8BlI91GDkqFeYVkybpql0,1941
 mkdocstrings_handlers/python/.mypy_cache/CACHEDIR.TAG,sha256=8cE6_FVTWMkDOw8fMKqhd_6IvaQPS4okWYQA1UeHatw,190
 mkdocstrings_handlers/python/__init__.py,sha256=k-0NWvXysr5RqWjtGyCozookveBB-ADZHIhgxvI1px8,128
-mkdocstrings_handlers/python/config.py,sha256=bXAw1KOLJdcVBOAE-WppDLMWqw8QqjwcP-jKCybtCjo,31647
+mkdocstrings_handlers/python/config.py,sha256=YUOP_DTPfvzYDeEweRePjSYE2TAD6HenNf1tifJXN2o,31639
 mkdocstrings_handlers/python/debug.py,sha256=4vqIbCbbz_vcjcFk6jPoF8E1kLig8AQEsQ93ybcjIVc,2894
-mkdocstrings_handlers/python/handler.py,sha256=f083vvw5k3PaFl0CKJ4DGiMXsCJDl2fmxiH4_tjoK5s,14940
+mkdocstrings_handlers/python/handler.py,sha256=DBYjKnbh0oe8muN8PU5zrhNNEuqk40lIjXX977_cnho,14860
 mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/python/rendering.py,sha256=DuNV-cI2Tie574yItj6CiE95THbKOxpZE0uvl50iGmI,23054
+mkdocstrings_handlers/python/rendering.py,sha256=zqJ5E9oSLDw4NJHAl1fngBZIzd5heCqo-WtctakBIfw,23021
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=nn0671f4bE7VqnTs-VQL3SGPACWAxb2uJBRcP2nwYng,427
 mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=sbbkQtl5bPm5mmmZ-VCyLtfsOuhSr-FrD2FUSlbK-Zs,4451
 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
 mkdocstrings_handlers/python/templates/material/_base/summary.html,sha256=2OR2p8zJ5I0mkknX7ZY7qj59orJH4e9HVg0S5DaUUsU,421
 mkdocstrings_handlers/python/templates/material/_base/summary.html.jinja,sha256=s5rEtPwncirxmPmF-F9LsFBhAay_HEQtHf7cDjh-WnM,730
 mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html,sha256=CSrl1A7woDmRxgMpYHArnKQGgilSbk8fvXgsx1OzPwU,454
-mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja,sha256=YUp1dbKjfUDfk6v2WvzjJLHx_wn9xow5zFHz-uUPTOA,641
+mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html.jinja,sha256=RvIqjTpOJj4rLkj72CJm9zYvQ0Ogd26MA4AXjjQw3kg,758
 mkdocstrings_handlers/python/templates/material/_base/summary/classes.html,sha256=hhFsCc_4quq7mPWMWKBMas1jNRjSOHoCmbz8gGR1by8,445
-mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja,sha256=EHbw3_4kfdSnxpsjdipQ5LS_dTIstCnbJmWgHuxjM3k,629
+mkdocstrings_handlers/python/templates/material/_base/summary/classes.html.jinja,sha256=Iv8U9CTyI3w-036poLjcgeLMpqKaSC4a91rizxZ6US4,743
 mkdocstrings_handlers/python/templates/material/_base/summary/functions.html,sha256=gm2x5_dy7KVWxBSZlY7gCjXyC0otT6n0pIpxTvjp8WA,451
-mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja,sha256=nTcdrc_UrI0c9ca9e9e4mVd7vVkxPSbTfR8qnB4vBzQ,645
+mkdocstrings_handlers/python/templates/material/_base/summary/functions.html.jinja,sha256=vloayD3SociyQJOlhLL3b9CNSekTYOyiVaur6zl6a_c,761
 mkdocstrings_handlers/python/templates/material/_base/summary/modules.html,sha256=4aM17FMv-a-h5IawwFtxDHw2AdI6fICyiKtdYckQc6s,445
-mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja,sha256=UDCRsFndFViOtVMlCwvvOcq9fQeLR72uws9EG1X-uxU,623
+mkdocstrings_handlers/python/templates/material/_base/summary/modules.html.jinja,sha256=cDhmzUVKsuuVzlWbR376hpME_Sh6KjSfvcT4c6KVkps,737
 mkdocstrings_handlers/python/templates/material/attribute.html,sha256=HkKz308jpCZj3PffJ5JtZC46rtkNNZ-2bE5zvaQQTRE,43
 mkdocstrings_handlers/python/templates/material/attribute.html.jinja,sha256=HkKz308jpCZj3PffJ5JtZC46rtkNNZ-2bE5zvaQQTRE,43
 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
 mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
 mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
 mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
-mkdocstrings_python-1.16.1.dist-info/METADATA,sha256=YL_y7h4CxG5Y03LH5FZGErO_SS599KUBlG3xujT0vYs,5570
-mkdocstrings_python-1.16.1.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
-mkdocstrings_python-1.16.1.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-mkdocstrings_python-1.16.1.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.16.1.dist-info/RECORD,,
+mkdocstrings_python-1.16.3.dist-info/METADATA,sha256=svj0uB9ijF1SrT_lnqTls9PHw8i1lWP__e90CUDWYrA,5572
+mkdocstrings_python-1.16.3.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
+mkdocstrings_python-1.16.3.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+mkdocstrings_python-1.16.3.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-1.16.3.dist-info/RECORD,,