mkdocstrings-python 1.16.9__py3-none-any.whl → 1.16.11__py3-none-any.whl

mkdocstrings_handlers/python/_internal/config.py

@@ -971,7 +971,7 @@ class Inventory:
         ),
     ]
 
-    base: Annotated[
+    base_url: Annotated[
         str | None,
         _Field(
             parent="inventories",
@@ -989,7 +989,7 @@ class Inventory:
 
     @property
     def _config(self) -> dict[str, Any]:
-        return {"base": self.base, "domains": self.domains}
+        return {"base_url": self.base_url, "domains": self.domains}
 
 
 # YORE: EOL 3.9: Replace `**_dataclass_options` with `frozen=True, kw_only=True` within line.

mkdocstrings_handlers/python/_internal/rendering.py

@@ -185,10 +185,12 @@ def do_format_signature(
     # Pygments sees it as a function call and not a function definition.
     # The result is that the function name is not parsed as such,
     # but instead as a regular name: `n` CSS class instead of `nf`.
-    # To fix it, we replace the first occurrence of an `n` CSS class
-    # with an `nf` one, unless we found `nf` already.
-    if signature.find('class="nf"') == -1:
-        signature = signature.replace('class="n"', 'class="nf"', 1)
+    # When the function name is a known special name like `__exit__`,
+    # Pygments will set an `fm` (function -> magic) CSS class.
+    # To fix this, we replace the CSS class in the first span with `nf`,
+    # unless we already found an `nf` span.
+    if not re.search(r'<span class="nf">', signature):
+        signature = re.sub(r'<span class="[a-z]+">', '<span class="nf">', signature, count=1)
 
     if stash := env.filters["stash_crossref"].stash:
         for key, value in stash.items():

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

@@ -39,7 +39,7 @@ Context:
           role="data" if attribute.parent.kind.value == "module" else "attr",
           id=html_id,
           class="doc doc-heading",
-          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute_name),
+          toc_label=('<code class="doc-symbol doc-symbol-toc doc-symbol-attribute"></code>&nbsp;'|safe if config.show_symbol_type_toc else '') + (config.toc_label if config.toc_label and root else attribute.name),
         ) %}
 
         {% block heading scoped %}
@@ -48,8 +48,10 @@ Context:
           This block renders the heading for the attribute.
           -#}
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-attribute"></code>{% endif %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-attribute-name">{{ config.heading if config.heading and root else attribute_name }}</span>
+          {% if config.heading and root %}
+            {{ config.heading }}
+          {% elif config.separate_signature %}
+            <span class="doc doc-object-name doc-attribute-name">{{ attribute_name }}</span>
           {% else %}
             {%+ filter highlight(language="python", inline=True) %}
               {{ attribute_name }}{% if attribute.annotation and config.show_signature_annotations %}: {{ attribute.annotation }}{% endif %}

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

@@ -47,8 +47,10 @@ Context:
           This block renders the heading for the class.
           -#}
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-class"></code>{% endif %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-class-name">{{ config.heading if config.heading and root else class_name }}</span>
+          {% if config.heading and root %}
+            {{ config.heading }}
+          {% elif config.separate_signature %}
+            <span class="doc doc-object-name doc-class-name">{{ class_name }}</span>
           {% elif config.merge_init_into_class and "__init__" in all_members %}
             {% with function = all_members["__init__"] %}
               {%+ filter highlight(language="python", inline=True) -%}

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

@@ -54,8 +54,10 @@ Context:
           This block renders the heading for the function.
           -#}
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-{{ symbol_type }}"></code>{% endif %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-function-name">{{ config.heading if config.heading and root else function_name }}</span>
+          {% if config.heading and root %}
+            {{ config.heading }}
+          {% elif config.separate_signature %}
+            <span class="doc doc-object-name doc-function-name">{{ function_name }}</span>
           {% else %}
             {%+ filter highlight(language="python", inline=True) -%}
               {#- YORE: Bump 2: Replace `"|get_template` with `.html.jinja"` within line. -#}

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

@@ -47,8 +47,10 @@ Context:
           This block renders the heading for the module.
           -#}
           {% if config.show_symbol_type_heading %}<code class="doc-symbol doc-symbol-heading doc-symbol-module"></code>{% endif %}
-          {% if config.separate_signature %}
-            <span class="doc doc-object-name doc-module-name">{{ config.heading if config.heading and root else module_name }}</span>
+          {% if config.heading and root %}
+            {{ config.heading }}
+          {% elif config.separate_signature %}
+            <span class="doc doc-object-name doc-module-name">{{ module_name }}</span>
           {% else %}
             <code>{{ module_name }}</code>
           {% endif %}

mkdocstrings_handlers/python/templates/material/style.css

@@ -9,6 +9,11 @@
   display: inline;
 }
 
+/* No text transformation from Material for MkDocs for H5 headings. */
+.md-typeset h5 .doc-object-name {
+  text-transform: none;
+}
+
 /* Max width for docstring sections tables. */
 .doc .md-typeset__table,
 .doc .md-typeset__table table {
@@ -30,6 +35,11 @@
   display: inline;
 }
 
+/* Default font size for parameter headings. */
+.md-typeset .doc-heading-parameter {
+  font-size: inherit;
+}
+
 /* Prefer space on the right, not the left of parameter permalinks. */
 .doc-heading-parameter .headerlink {
   margin-left: 0 !important;

{mkdocstrings_python-1.16.9.dist-info → mkdocstrings_python-1.16.11.dist-info}/METADATA

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

{mkdocstrings_python-1.16.9.dist-info → mkdocstrings_python-1.16.11.dist-info}/RECORD

@@ -1,20 +1,20 @@
 mkdocstrings_handlers/python/__init__.py,sha256=lg-XSQYS-o5J9_jBU35SA7rCW54CK0JsNcrSgsCfW2k,1614
 mkdocstrings_handlers/python/_internal/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-mkdocstrings_handlers/python/_internal/config.py,sha256=JR6GVLLdVpCyCzjpJpFIY_bsQwQmo76PSlZCx28bUbQ,33469
+mkdocstrings_handlers/python/_internal/config.py,sha256=SsRB0fDCRAe7myUD5govrAFX9_4LkoaegQkz_DAd7Ek,33481
 mkdocstrings_handlers/python/_internal/debug.py,sha256=KnkMM_XSjcE0-9U86AZPucS2hsCD6Rfn_BgMs7_xc3U,2845
 mkdocstrings_handlers/python/_internal/handler.py,sha256=FqIQzxz8k1COAlCzNlKlTzDlbEctXq77kaCxfl2-ILI,15976
-mkdocstrings_handlers/python/_internal/rendering.py,sha256=HeRIgG8g7eeqfZLx9bOavLmKgDtlMW_FuzWvP_k2epU,26493
+mkdocstrings_handlers/python/_internal/rendering.py,sha256=D6PpdX8GV3G9kqc1ILYQ4fYOgxYE00BBjjZtJ8IY2hU,26658
 mkdocstrings_handlers/python/config.py,sha256=gDuOF8vYwo00opwtObQ55WQq2ECynirwcaGnd0VCHg4,477
 mkdocstrings_handlers/python/handler.py,sha256=xZnhzVC_y6ni3eX_RRO8132ED7DqXqU7IjA6sm8lCk8,480
 mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/rendering.py,sha256=xSfGS8K1uo1raw4ChhTyZE1bxdM8NKK4uD1vCO_R4lA,486
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=M_eHCPrDCC9FFzgTaOS61MqUTUK1ha85SK1kW2lQeBY,310
-mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=gP4515D-ulhTMvc48m3zcOAbfeVP--zkuTC3uAMBlsk,4807
+mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=ekZDKvC-2pbubwwBvBppooIWotyivCxh1U81lT0ga_8,4838
 mkdocstrings_handlers/python/templates/material/_base/backlinks.html.jinja,sha256=FFrvIa-KH-DhT1cpc9HL0ecShR2gUVGs3VT9c1q88z8,467
 mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=EQuTDoMRrICrieD62VZ9Ay-tw3sJQe4Jh7yDnFe1zFk,307
 mkdocstrings_handlers/python/templates/material/_base/children.html.jinja,sha256=JKQtXVemw8SJ1lPbCw_BNUKDnbtvnqzmC5cwhiYqxow,6541
 mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=phAElLOLdaCRMW7uv1G5ePW3deavBpCp29OsK2Njn6E,298
-mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=1Sm-Dk_VfL4UHnvg-Y_2GwFrx_HUyUTYgVbv5aYfi0A,9686
+mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=5j876SnXhx6-MpEJs25ADlKKyMRIr4u-1p5Q36UhLKE,9717
 mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=x2JcxMNtM0xc1qZv1cKJQv4svNXyFThtKLJ66YqFHAQ,310
 mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja,sha256=q88YLwuw2KRlxQMADP14XsnzDt0UYk8nmmzKb1ECcbQ,4247
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=YAwZQv3ABAtcge8-PTpi0jIAaDONE8E2sWiBSSKSl98,343
@@ -46,7 +46,7 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinj
 mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=ngA65vQBP142R6UeOpSVDUlVLwBjfiJfYMyi7WjHH9I,313
 mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha256=RZX2Wbmhlldvr0H8SB0hFOiHaxY7G7wnKNOhBRoJpJY,4688
 mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=k-cXHimSwRoXuwF0H26XvdaW5mgIl9miMd7zD641oj8,307
-mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=YGV8T5SqUwosqbDTQ1EtcuaNOYmtd3-OH8WDupc_TFM,6274
+mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=I5NyacXIFEVwIGPntS1w3nKQNiKKDHC3dRc2_Ekj_R4,6305
 mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=zeazKqY21Xjch_qEIXvKWI-FM6MVlNSxc0kFoQghk50,301
 mkdocstrings_handlers/python/templates/material/_base/labels.html.jinja,sha256=mue5CMl2WQpagj3aYqbUiAQX0P72aLCgY3MX_zEpE8s,786
 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
 mkdocstrings_handlers/python/templates/material/_base/languages/zh.html,sha256=FzTS6G4SgdlHbhEPKqd6y2wU_ewQkPUm1_kzET6NIJ4,319
 mkdocstrings_handlers/python/templates/material/_base/languages/zh.html.jinja,sha256=Zr0o9OJv_NWZ2IHZrQYUpM7U-GCnRNr9y5FVQzIHLxY,1125
 mkdocstrings_handlers/python/templates/material/_base/module.html,sha256=lv0T7AeEMQBL6SNX85YXHH7fzlpuEe8vhE5n9Dsexhk,301
-mkdocstrings_handlers/python/templates/material/_base/module.html.jinja,sha256=vfKAatQC5Veym5u9eW-t-Ljtv6Kq4v_oDacU40euE5Q,4648
+mkdocstrings_handlers/python/templates/material/_base/module.html.jinja,sha256=aSZwWWtlZFNp91tg-Jk5JLL-UfmzXJHzqta32Pgu9V8,4679
 mkdocstrings_handlers/python/templates/material/_base/signature.html,sha256=1GP2y9T0clgpzZBTcrat5Vj8zhANgQGfT1KU1KxXPI8,310
 mkdocstrings_handlers/python/templates/material/_base/signature.html.jinja,sha256=UsGg2aFf1J68SPXpWpJ3DvsTbFTSIKVeLc7V-L3JtHc,5401
 mkdocstrings_handlers/python/templates/material/_base/summary.html,sha256=5EPKJLvlth7SlgAWjy5bRQwDmcFq5aFaUQjTm-IHt30,304
@@ -124,7 +124,7 @@ mkdocstrings_handlers/python/templates/material/module.html,sha256=jcyPnLCOyVu8C
 mkdocstrings_handlers/python/templates/material/module.html.jinja,sha256=ws59JJTsITCndGTXSUXoQ14BcXsKJswZW24ceJaHGNI,40
 mkdocstrings_handlers/python/templates/material/signature.html,sha256=Thct33klO6ZUQnXYwilH1Tbd9H7NmtahTGd7wy2JdoA,76
 mkdocstrings_handlers/python/templates/material/signature.html.jinja,sha256=EvvFPpG9PEUi25f-_2V0iVXTsUlvC9iTWtgFbJ3YVeI,43
-mkdocstrings_handlers/python/templates/material/style.css,sha256=Zs9KDad75ApnOieglrvCu1VVaLgYqDUUrsm2CcFGMeI,4198
+mkdocstrings_handlers/python/templates/material/style.css,sha256=sEe5c2ET1KNFkvujyQmB4lMmHHKzdmMurMiwwIHOjd0,4440
 mkdocstrings_handlers/python/templates/material/summary.html,sha256=5JZ1WVzGzeZisCRk3RnP9x7nN8HDPqUPTeMXaXYjqBI,74
 mkdocstrings_handlers/python/templates/material/summary.html.jinja,sha256=Wd7HXzuU0mriz82Riy2PDpRbcMo-7IHrAdBsvxbtKrY,41
 mkdocstrings_handlers/python/templates/material/summary/attributes.html,sha256=KHEuRQIYPo0r-65XVpipHcivi5Q9iINlSPpS4cxuZCQ,85
@@ -184,8 +184,8 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha25
 mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=OIRkMlzFJ_wlXFzB96874tz6zn8UVFpEQX2hQJru2ug,79
 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.9.dist-info/METADATA,sha256=VYWULr-wO2drbpMlcF0lLo8FSBVsazMgcZbBs1tHJ74,5606
-mkdocstrings_python-1.16.9.dist-info/WHEEL,sha256=thaaA2w1JzcGC48WYufAs8nrYZjJm8LqNfnXFOFyCC4,90
-mkdocstrings_python-1.16.9.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
-mkdocstrings_python-1.16.9.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.16.9.dist-info/RECORD,,
+mkdocstrings_python-1.16.11.dist-info/METADATA,sha256=QEI05GPz0CrFfdEZszYg8Gr95U7KNHaGPiu9ytMopjA,5607
+mkdocstrings_python-1.16.11.dist-info/WHEEL,sha256=tSfRZzRHthuv7vxpI4aehrdN9scLjk-dCJkPLzkHxGg,90
+mkdocstrings_python-1.16.11.dist-info/entry_points.txt,sha256=6OYgBcLyFCUgeqLgnvMyOJxPCWzgy7se4rLPKtNonMs,34
+mkdocstrings_python-1.16.11.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-1.16.11.dist-info/RECORD,,

{mkdocstrings_python-1.16.9.dist-info → mkdocstrings_python-1.16.11.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: pdm-backend (2.4.3)
+Generator: pdm-backend (2.4.4)
 Root-Is-Purelib: true
 Tag: py3-none-any