mkdocstrings-python 1.10.7__py3-none-any.whl → 1.10.9__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.
Files changed (11) hide show
  1. mkdocstrings_handlers/python/handler.py +2 -2
  2. mkdocstrings_handlers/python/rendering.py +5 -2
  3. mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja +3 -3
  4. mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja +3 -3
  5. mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja +3 -3
  6. mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja +3 -3
  7. mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja +2 -2
  8. {mkdocstrings_python-1.10.7.dist-info → mkdocstrings_python-1.10.9.dist-info}/METADATA +3 -2
  9. {mkdocstrings_python-1.10.7.dist-info → mkdocstrings_python-1.10.9.dist-info}/RECORD +11 -11
  10. {mkdocstrings_python-1.10.7.dist-info → mkdocstrings_python-1.10.9.dist-info}/WHEEL +0 -0
  11. {mkdocstrings_python-1.10.7.dist-info → mkdocstrings_python-1.10.9.dist-info}/licenses/LICENSE +0 -0
mkdocstrings_handlers/python/handler.py CHANGED
@@ -19,7 +19,7 @@ from griffe import (
19
19
  ModulesCollection,
20
20
  Parser,
21
21
  load_extensions,
22
- patch_logger,
22
+ patch_loggers,
23
23
  )
24
24
  from mkdocstrings.extension import PluginError
25
25
  from mkdocstrings.handlers.base import BaseHandler, CollectionError, CollectorItem
@@ -50,7 +50,7 @@ else:
50
50
 
51
51
  logger = get_logger(__name__)
52
52
 
53
- patch_logger(get_logger)
53
+ patch_loggers(get_logger)
54
54
 
55
55
 
56
56
  class PythonHandler(BaseHandler):
mkdocstrings_handlers/python/rendering.py CHANGED
@@ -295,7 +295,10 @@ def do_crossref(path: str, *, brief: bool = True) -> Markup:
295
295
  full_path = path
296
296
  if brief:
297
297
  path = full_path.split(".")[-1]
298
- return Markup("<span data-autorefs-optional-hover={full_path}>{path}</span>").format(full_path=full_path, path=path)
298
+ return Markup("<autoref identifier={full_path} optional hover>{path}</autoref>").format(
299
+ full_path=full_path,
300
+ path=path,
301
+ )
299
302
 
300
303
 
301
304
  @lru_cache
@@ -327,7 +330,7 @@ def do_multi_crossref(text: str, *, code: bool = True) -> Markup:
327
330
  path = match.group()
328
331
  path_var = f"path{group_number}"
329
332
  variables[path_var] = path
330
- return f"<span data-autorefs-optional-hover={{{path_var}}}>{{{path_var}}}</span>"
333
+ return f"<autoref identifier={{{path_var}}} optional hover>{{{path_var}}}</autoref>"
331
334
 
332
335
  text = re.sub(r"([\w.]+)", repl, text)
333
336
  if code:
mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja CHANGED
@@ -33,7 +33,7 @@ Context:
33
33
  <tbody>
34
34
  {% for attribute in section.value %}
35
35
  <tr class="doc-section-item">
36
- <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></td>
36
+ <td><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></td>
37
37
  <td>
38
38
  {% if attribute.annotation %}
39
39
  {% with expression = attribute.annotation %}
@@ -58,7 +58,7 @@ Context:
58
58
  <ul>
59
59
  {% for attribute in section.value %}
60
60
  <li class="doc-section-item field-body">
61
- <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></b>
61
+ <b><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></b>
62
62
  {% if attribute.annotation %}
63
63
  {% with expression = attribute.annotation %}
64
64
  (<code>{% include "expression"|get_template with context %}</code>)
@@ -85,7 +85,7 @@ Context:
85
85
  <tbody>
86
86
  {% for attribute in section.value %}
87
87
  <tr class="doc-section-item">
88
- <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></td>
88
+ <td><code><autoref identifier="{{ obj.path }}.{{ attribute.name }}" optional hover>{{ attribute.name }}</autoref></code></td>
89
89
  <td class="doc-attribute-details">
90
90
  <div class="doc-md-description">
91
91
  {{ attribute.description|convert_markdown(heading_level, html_id) }}
mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja CHANGED
@@ -32,7 +32,7 @@ Context:
32
32
  <tbody>
33
33
  {% for class in section.value %}
34
34
  <tr class="doc-section-item">
35
- <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></td>
35
+ <td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
36
36
  <td>
37
37
  <div class="doc-md-description">
38
38
  {{ class.description|convert_markdown(heading_level, html_id) }}
@@ -50,7 +50,7 @@ Context:
50
50
  <ul>
51
51
  {% for class in section.value %}
52
52
  <li class="doc-section-item field-body">
53
- <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></b>
53
+ <b><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></b>
54
54
  –
55
55
  <div class="doc-md-description">
56
56
  {{ class.description|convert_markdown(heading_level, html_id) }}
@@ -72,7 +72,7 @@ Context:
72
72
  <tbody>
73
73
  {% for class in section.value %}
74
74
  <tr class="doc-section-item">
75
- <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></td>
75
+ <td><code><autoref identifier="{{ obj.path }}.{{ class.name }}" optional hover>{{ class.name }}</autoref></code></td>
76
76
  <td class="doc-class-details">
77
77
  <div class="doc-md-description">
78
78
  {{ class.description|convert_markdown(heading_level, html_id) }}
mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja CHANGED
@@ -33,7 +33,7 @@ Context:
33
33
  {% for function in section.value %}
34
34
  {% if not function.name == "__init__" or not config.merge_init_into_class %}
35
35
  <tr class="doc-section-item">
36
- <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></td>
36
+ <td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
37
37
  <td>
38
38
  <div class="doc-md-description">
39
39
  {{ function.description|convert_markdown(heading_level, html_id) }}
@@ -53,7 +53,7 @@ Context:
53
53
  {% for function in section.value %}
54
54
  {% if not function.name == "__init__" or not config.merge_init_into_class %}
55
55
  <li class="doc-section-item field-body">
56
- <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></b>
56
+ <b><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></b>
57
57
  –
58
58
  <div class="doc-md-description">
59
59
  {{ function.description|convert_markdown(heading_level, html_id) }}
@@ -77,7 +77,7 @@ Context:
77
77
  {% for function in section.value %}
78
78
  {% if not function.name == "__init__" or not config.merge_init_into_class %}
79
79
  <tr class="doc-section-item">
80
- <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></td>
80
+ <td><code><autoref identifier="{{ obj.path }}.{{ function.name }}" optional hover>{{ function.name }}</autoref></code></td>
81
81
  <td class="doc-function-details">
82
82
  <div class="doc-md-description">
83
83
  {{ function.description|convert_markdown(heading_level, html_id) }}
mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja CHANGED
@@ -32,7 +32,7 @@ Context:
32
32
  <tbody>
33
33
  {% for module in section.value %}
34
34
  <tr class="doc-section-item">
35
- <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></td>
35
+ <td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
36
36
  <td>
37
37
  <div class="doc-md-description">
38
38
  {{ module.description|convert_markdown(heading_level, html_id) }}
@@ -50,7 +50,7 @@ Context:
50
50
  <ul>
51
51
  {% for module in section.value %}
52
52
  <li class="doc-section-item field-body">
53
- <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></b>
53
+ <b><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></b>
54
54
  –
55
55
  <div class="doc-md-description">
56
56
  {{ module.description|convert_markdown(heading_level, html_id) }}
@@ -72,7 +72,7 @@ Context:
72
72
  <tbody>
73
73
  {% for module in section.value %}
74
74
  <tr class="doc-section-item">
75
- <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></td>
75
+ <td><code><autoref identifier="{{ obj.path }}.{{ module.name }}" optional hover>{{ module.name }}</autoref></code></td>
76
76
  <td class="doc-module-details">
77
77
  <div class="doc-md-description">
78
78
  {{ module.description|convert_markdown(heading_level, html_id) }}
mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja CHANGED
@@ -21,7 +21,7 @@ which is a tree-like structure representing a Python expression.
21
21
  annotation_path (str): Either "brief", "source", or "full".
22
22
 
23
23
  Returns:
24
- Either a cross-reference (using an autorefs span) or the name itself.
24
+ Either a cross-reference (using an autoref element) or the name itself.
25
25
  -#}
26
26
  {%- with full = name.canonical_path -%}
27
27
  {%- if annotation_path == "brief" -%}
@@ -34,7 +34,7 @@ which is a tree-like structure representing a Python expression.
34
34
  {%- for title, path in annotation|split_path(full) -%}
35
35
  {%- if not signature or config.signature_crossrefs -%}
36
36
  {%- filter stash_crossref(length=title|length) -%}
37
- <span data-autorefs-optional{% if title != path %}-hover{% endif %}="{{ path }}">{{ title }}</span>
37
+ <autoref identifier="{{ path }}" optional{% if title != path %} hover{% endif %}>{{ title }}</autoref>
38
38
  {%- endfilter -%}
39
39
  {%- else -%}
40
40
  {{ title }}
{mkdocstrings_python-1.10.7.dist-info → mkdocstrings_python-1.10.9.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocstrings-python
3
- Version: 1.10.7
3
+ Version: 1.10.9
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: ISC
@@ -29,7 +29,8 @@ Project-URL: Gitter, https://gitter.im/mkdocstrings/python
29
29
  Project-URL: Funding, https://github.com/sponsors/pawamoy
30
30
  Requires-Python: >=3.8
31
31
  Requires-Dist: mkdocstrings>=0.25
32
- Requires-Dist: griffe>=0.48
32
+ Requires-Dist: mkdocs-autorefs>=1.0
33
+ Requires-Dist: griffe>=0.49
33
34
  Description-Content-Type: text/markdown
34
35
 
35
36
  <h1 align="center">mkdocstrings-python</h1>
{mkdocstrings_python-1.10.7.dist-info → mkdocstrings_python-1.10.9.dist-info}/RECORD RENAMED
@@ -1,8 +1,8 @@
1
1
  mkdocstrings_handlers/python/__init__.py,sha256=k-0NWvXysr5RqWjtGyCozookveBB-ADZHIhgxvI1px8,128
2
2
  mkdocstrings_handlers/python/debug.py,sha256=4vqIbCbbz_vcjcFk6jPoF8E1kLig8AQEsQ93ybcjIVc,2894
3
- mkdocstrings_handlers/python/handler.py,sha256=kBtn7O213IJjWxLhaqIBuz-jdhgeJ159OIPAl6EBjJk,24287
3
+ mkdocstrings_handlers/python/handler.py,sha256=hwHdy6CWY9cMIAophgRGzLvO3LyesD4CL3BFVoG-6PI,24289
4
4
  mkdocstrings_handlers/python/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
5
- mkdocstrings_handlers/python/rendering.py,sha256=AWoWTDwzFAjuGdzC8ZuxBKP8INPrLmPsm3B4LbFxzVg,17950
5
+ mkdocstrings_handlers/python/rendering.py,sha256=mtvit6HJVGd9h-pe3mSVp5c6A_NhfjMET6fWe7yhTR8,17979
6
6
  mkdocstrings_handlers/python/templates/material/_base/attribute.html,sha256=nn0671f4bE7VqnTs-VQL3SGPACWAxb2uJBRcP2nwYng,427
7
7
  mkdocstrings_handlers/python/templates/material/_base/attribute.html.jinja,sha256=_NTap6NDkJUMpJJaQ4mCIzsxVWwkv4Z6ZdaCxLe34mo,4361
8
8
  mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=mOafkSlphFQJLWfrYrIMFVRGi2yjdtN6iJh8bPt7uRI,424
@@ -14,15 +14,15 @@ mkdocstrings_handlers/python/templates/material/_base/docstring.html.jinja,sha25
14
14
  mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=yShTX2BBdYlOGCj-Hb1NIAeWldLGE_toMDIOn1OYdPs,460
15
15
  mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html.jinja,sha256=zdJPdN7hQ-lisIQU6yumC26awgoebtXbH10CR8FvQEo,635
16
16
  mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html,sha256=0c4KoMA2oehvEvNZvOgfvSxTMhVtOSl6R4r1fUoc3DE,460
17
- mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja,sha256=KHgnGJHMK6RFJfKnCWAnPoDLwcKdFkqycVjLUCWkBdE,4099
17
+ mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html.jinja,sha256=veaZPRwvBRVpVrZPPu_jXHaWedI9pQpQ8vOBZucSnQI,4108
18
18
  mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html,sha256=rqwypiSrquMy6vJfQ5alYRBnH4w0ZxS01HXflFjakvw,451
19
- mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja,sha256=8Ss7jU8pJmuxkA5xxT7wpv4C50omNoIhTEFtPuB4oWg,3066
19
+ mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html.jinja,sha256=clXR01--zquJ8godqNGBEl0iDHU3PXXAfW1sPSooyFw,3075
20
20
  mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html,sha256=8z1IC698vA4J_pJU5s71Hv6FNMRkeL-W4MWo_kiN4C8,454
21
21
  mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html.jinja,sha256=MAF1QJKLVQaLhZzdk-3LEcfdvTUac6u5EcEuAmeaaFw,960
22
22
  mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html,sha256=SGnlViyisdxaA5l-ALfV-bRNHcdXIWqO-j87uZhwbUI,457
23
- mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja,sha256=hfnk686Drh61gMOXdLdHJEsUmAm67QhF5H6Z9LpcOZw,3605
23
+ mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html.jinja,sha256=bAOsk8A8U1ZqvJvhteoElwCTeTKlZwnWoYz9APQqL5M,3614
24
24
  mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html,sha256=JWBpk6tJN12tEZVqZ8kK2L_mmk0lkIdWuYYtfw_4dYQ,451
25
- mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja,sha256=ja49-_cYSxhnrr4d_lVY775h_TaEtFqVuUEhmdTjXS0,3080
25
+ mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html.jinja,sha256=I9I6ae2nNzskylExEzSE7jLjXNBcN7ckWdMzlvPmN5g,3089
26
26
  mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html,sha256=yDBXgj-qMDQP3Si-ZjDj-Z0ksRl3BP6YbwHy8fZrmdU,478
27
27
  mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html.jinja,sha256=euftwT4ckVzwklzJQ9JfznTx1vcD0NTUswOa67A-rz8,3897
28
28
  mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html,sha256=xKQQydQJst6CJT0nH6RPWDXH92tRH_k1EIiPNoHzI1g,460
@@ -38,7 +38,7 @@ mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html.jinja
38
38
  mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=-aNSOHi5lvqheUzklSRThN7UeCdsqTHm35CyKi5yaWU,448
39
39
  mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html.jinja,sha256=8B9dOocrYMffBCPN6DImWcuWp_5dFJ9_6EaMYpdmKxk,4510
40
40
  mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=JU-ScDWoFk0m6x0Dx50LKN9yW7RzTWj4VYcJYEIQ144,430
41
- mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha256=3uF_EVyGlUH_XqIGC6VR8EIgchlkjysT5wFik0BTah4,3076
41
+ mkdocstrings_handlers/python/templates/material/_base/expression.html.jinja,sha256=tz5BbJcb87Xtd2pBI5xwUGTgDHQR2swSUV9Vjy_I-HM,3081
42
42
  mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=tFpXIt5sIhjXjTCXhtYZ4cGpbgdbaIdbm8HdP9Pccik,424
43
43
  mkdocstrings_handlers/python/templates/material/_base/function.html.jinja,sha256=L7McTQ63BIoQR8VZNs2q8W_qSDSJrqYjekcJd4DD3oM,5238
44
44
  mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=SJGvRoTYj9AImTRRn-SP4nGAdpfz-ai4gGgHGxMOJK8,418
@@ -177,7 +177,7 @@ mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html.jinja,sha25
177
177
  mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
178
178
  mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html.jinja,sha256=OuvrkorxuL0gKZNYneann1bwd1Z2i5bBY7SbC496HDw,46
179
179
  mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
180
- mkdocstrings_python-1.10.7.dist-info/METADATA,sha256=qsVkseUMXacuI4pNbjM7SAcqNKG-crylnsuQHxTQIL8,5551
181
- mkdocstrings_python-1.10.7.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
182
- mkdocstrings_python-1.10.7.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
183
- mkdocstrings_python-1.10.7.dist-info/RECORD,,
180
+ mkdocstrings_python-1.10.9.dist-info/METADATA,sha256=q52ofu4HFQjbZEhr3FQx_XQdsbmKEK8pSGMc9Ip6l7Y,5587
181
+ mkdocstrings_python-1.10.9.dist-info/WHEEL,sha256=rSwsxJWe3vzyR5HCwjWXQruDgschpei4h_giTm0dJVE,90
182
+ mkdocstrings_python-1.10.9.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
183
+ mkdocstrings_python-1.10.9.dist-info/RECORD,,