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

mkdocstrings_handlers/python/config.py

@@ -568,6 +568,14 @@ class PythonInputOptions:
         ),
     ] = False
 
+    show_overloads: Annotated[
+        bool,
+        Field(
+            group="signatures",
+            description="Show the overloads of a function or method.",
+        ),
+    ] = True
+
     separate_signature: Annotated[
         bool,
         Field(

mkdocstrings_handlers/python/handler.py

@@ -128,9 +128,11 @@ class PythonHandler(BaseHandler):
             # If it's not absolute, make path relative to the config file path, then make it absolute.
             if not os.path.isabs(path):
                 path = os.path.abspath(base_dir / path)  # noqa: PLW2901
-            # Don't add duplicates.
-            if path not in search_paths:
-                search_paths.insert(0, path)
+            # Remove pre-listed paths.
+            if path in search_paths:
+                search_paths.remove(path)
+            # Give precedence to user-provided paths.
+            search_paths.insert(0, path)
 
         self._paths = search_paths
         self._modules_collection: ModulesCollection = ModulesCollection()

mkdocstrings_handlers/python/templates/material/_base/class.html.jinja

@@ -82,7 +82,7 @@ Context:
         {% if config.merge_init_into_class %}
           {% if "__init__" in all_members %}
             {% with function = all_members["__init__"] %}
-              {% if function.overloads %}
+              {% if function.overloads and config.show_overloads %}
                 <div class="doc-overloads">
                   {% for overload in function.overloads %}
                     {% filter format_signature(overload, config.line_length, annotations=True, crossrefs=config.signature_crossrefs) %}

mkdocstrings_handlers/python/templates/material/_base/function.html.jinja

@@ -80,7 +80,7 @@ Context:
         This block renders the signature for the function,
         as well as its overloaded signatures if any.
         -#}
-        {% if function.overloads %}
+        {% if function.overloads and config.show_overloads %}
           <div class="doc-overloads">
             {% for overload in function.overloads %}
               {% filter format_signature(overload, config.line_length, annotations=True, crossrefs=config.signature_crossrefs) %}

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: mkdocstrings-python
-Version: 1.15.1
+Version: 1.16.1
 Summary: A Python handler for mkdocstrings.
 Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
 License: ISC

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

@@ -148,9 +148,9 @@ 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=dZTBl2BbEyVc_o8PW0rReWHDzdqYstOP7fnlWioRVk0,31459
+mkdocstrings_handlers/python/config.py,sha256=bXAw1KOLJdcVBOAE-WppDLMWqw8QqjwcP-jKCybtCjo,31647
 mkdocstrings_handlers/python/debug.py,sha256=4vqIbCbbz_vcjcFk6jPoF8E1kLig8AQEsQ93ybcjIVc,2894
-mkdocstrings_handlers/python/handler.py,sha256=0ap57utWbw6o4LWLhZOQWsr_H4Fr7t1zcCmV6xfqY-w,14849
+mkdocstrings_handlers/python/handler.py,sha256=f083vvw5k3PaFl0CKJ4DGiMXsCJDl2fmxiH4_tjoK5s,14940
 mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/rendering.py,sha256=DuNV-cI2Tie574yItj6CiE95THbKOxpZE0uvl50iGmI,23054
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=nn0671f4bE7VqnTs-VQL3SGPACWAxb2uJBRcP2nwYng,427
@@ -158,7 +158,7 @@ mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha25
 mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=mOafkSlphFQJLWfrYrIMFVRGi2yjdtN6iJh8bPt7uRI,424
 mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=Bu5dsIKcf5bX0_VzfSADmHvxXlY6K8wYBvXtuXtKVsU,6391
 mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=x0M8Wjk7TC9cgnstMoukLVQvxZUEMFjQA0VJQPEAC9Y,415
-mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=uwAeSsn0xplvmaPQKxE3aq82lYYi_t9qDZcWMmpLdwI,8695
+mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=HZdvHheL3s5pQYTejXNnPTTM6nYjHFvMLDOgBFxIc7Y,8721
 mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=9gDeMzbEUGfOBklwvriH5HMfcotOcaXUvlgLC9klTi8,427
 mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja,sha256=7SMBYzPGNaHoFpIXkREjye_bibXjK-0SMKngY8cmj4A,3129
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=yShTX2BBdYlOGCj-Hb1NIAeWldLGE_toMDIOn1OYdPs,460
@@ -190,7 +190,7 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinj
 mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=JU-ScDWoFk0m6x0Dx50LKN9yW7RzTWj4VYcJYEIQ144,430
 mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha256=kfvwxwW6BrHLAEd-h7YOUWMu4lFaOrUEPvt9sD_y0G0,4393
 mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=tFpXIt5sIhjXjTCXhtYZ4cGpbgdbaIdbm8HdP9Pccik,424
-mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=KyiqTv51KNJmItZmdzV0BuUsr341yKn4um7exYkJ2Is,5718
+mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=MAlOHqt7GRru5wb2M-gUzHT_6u8N5QgamZdFy-OZUro,5744
 mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=SJGvRoTYj9AImTRRn-SP4nGAdpfz-ai4gGgHGxMOJK8,418
 mkdocstrings_handlers/python/templates/material/_base/labels.html.jinja,sha256=mue5CMl2WQpagj3aYqbUiAQX0P72aLCgY3MX_zEpE8s,786
 mkdocstrings_handlers/python/templates/material/_base/language.html,sha256=Qvw8RvhTvKk3-OobTEOyWsh5yE3WbIWW4meoR4X_5fY,424
@@ -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.15.1.dist-info/METADATA,sha256=t40RdUjCz6lTAvehXWO4OCzICWBqXjBEvEs55iCtVwI,5570
-mkdocstrings_python-1.15.1.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
-mkdocstrings_python-1.15.1.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-mkdocstrings_python-1.15.1.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.15.1.dist-info/RECORD,,
+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,,