mkdocstrings-python 1.11.0__py3-none-any.whl → 1.11.1__py3-none-any.whl

mkdocstrings_handlers/python/handler.py

@@ -85,6 +85,8 @@ class PythonHandler(BaseHandler):
         "separate_signature": False,
         "line_length": 60,
         "merge_init_into_class": False,
+        "relative_crossrefs": False,
+        "scoped_crossrefs": False,
         "show_docstring_attributes": True,
         "show_docstring_functions": True,
         "show_docstring_classes": True,
@@ -168,6 +170,8 @@ class PythonHandler(BaseHandler):
         docstring_options (dict): The options for the docstring parser. See [docstring parsers](https://mkdocstrings.github.io/griffe/reference/docstrings/) and their options in Griffe docs.
         docstring_section_style (str): The style used to render docstring sections. Options: `table`, `list`, `spacy`. Default: `"table"`.
         merge_init_into_class (bool): Whether to merge the `__init__` method into the class' signature and docstring. Default: `False`.
+        relative_crossrefs (bool): Whether to enable the relative crossref syntax. Default: `False`.
+        scoped_crossrefs (bool): Whether to enable the scoped crossref ability. Default: `False`.
         show_if_no_docstring (bool): Show the object heading even if it has no docstring or children with docstrings. Default: `False`.
         show_docstring_attributes (bool): Whether to display the "Attributes" section in the object's docstring. Default: `True`.
         show_docstring_functions (bool): Whether to display the "Functions" or "Methods" sections in the object's docstring. Default: `True`.

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

@@ -133,8 +133,10 @@ Context:
           {% endwith %}
           {% if config.merge_init_into_class %}
             {% if "__init__" in class.all_members and class.all_members["__init__"].has_docstring %}
-              {% with docstring_sections = class.all_members["__init__"].docstring.parsed %}
-                {% include "docstring"|get_template with context %}
+              {% with function = class.all_members["__init__"] %}
+                {% with obj = function, docstring_sections = function.docstring.parsed %}
+                  {% include "docstring"|get_template with context %}
+                {% endwith %}
               {% endwith %}
             {% endif %}
           {% endif %}

{mkdocstrings_python-1.11.0.dist-info → mkdocstrings_python-1.11.1.dist-info}/METADATA

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

{mkdocstrings_python-1.11.0.dist-info → mkdocstrings_python-1.11.1.dist-info}/RECORD

@@ -1,6 +1,6 @@
 mkdocstrings_handlers/python/__init__.py,sha256=k-0NWvXysr5RqWjtGyCozookveBB-ADZHIhgxvI1px8,128
 mkdocstrings_handlers/python/debug.py,sha256=4vqIbCbbz_vcjcFk6jPoF8E1kLig8AQEsQ93ybcjIVc,2894
-mkdocstrings_handlers/python/handler.py,sha256=0e8M6j5oHzUoPYUt--n1nN_XmlG-AMc4nXJUezvPRto,24355
+mkdocstrings_handlers/python/handler.py,sha256=VXw9c82lpVfAiNRezlU8_SwPi0dNPE7gdk0KEvjiEss,24626
 mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 mkdocstrings_handlers/python/rendering.py,sha256=225Gi6KJKxcL7wpReFsA19_GXetdgiwF-fe006Oe5rY,19939
 mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=nn0671f4bE7VqnTs-VQL3SGPACWAxb2uJBRcP2nwYng,427
@@ -8,7 +8,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=o7JzhXx1OSo9MM-z_gks6H1aTETIPFFvTyE1St392Xs,6414
 mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=x0M8Wjk7TC9cgnstMoukLVQvxZUEMFjQA0VJQPEAC9Y,415
-mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=3_kmoqspe9abryiv4UeBX2Nlwl3uHtR8z5YvbueSb-M,7229
+mkdocstrings_handlers/python/templates/material/_base/class.html.jinja,sha256=76C9AQ1_EMHY9sRtzmQi_k0Jc234NZR2sF8yB_dXazE,7324
 mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=9gDeMzbEUGfOBklwvriH5HMfcotOcaXUvlgLC9klTi8,427
 mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja,sha256=1kqZ_T7WMGQgFDuWQJaozLAk2FPTxNPyQuiDbFllRks,3133
 mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=yShTX2BBdYlOGCj-Hb1NIAeWldLGE_toMDIOn1OYdPs,460
@@ -177,7 +177,7 @@ 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.11.0.dist-info/METADATA,sha256=-kJIz7Ck3C3uUoFUVItVMHhSDGNpHuiTnSpgYqADUMc,5587
-mkdocstrings_python-1.11.0.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
-mkdocstrings_python-1.11.0.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
-mkdocstrings_python-1.11.0.dist-info/RECORD,,
+mkdocstrings_python-1.11.1.dist-info/METADATA,sha256=Bw2PxWuqGM2Z4BiVYVzyQ8hD1hem07mzKfHucTJ6-2I,5587
+mkdocstrings_python-1.11.1.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
+mkdocstrings_python-1.11.1.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
+mkdocstrings_python-1.11.1.dist-info/RECORD,,