mkdocstrings-python 1.7.0__tar.gz → 1.7.1__tar.gz

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 (78) hide show
  1. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/PKG-INFO +1 -1
  2. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/pyproject.toml +1 -1
  3. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/class.html +8 -8
  4. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html +4 -4
  5. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/LICENSE +0 -0
  6. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/README.md +0 -0
  7. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/py.typed +0 -0
  8. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/__init__.py +0 -0
  9. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/handler.py +0 -0
  10. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/rendering.py +0 -0
  11. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html +0 -0
  12. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/children.html +0 -0
  13. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html +0 -0
  14. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html +0 -0
  15. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html +0 -0
  16. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html +0 -0
  17. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html +0 -0
  18. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html +0 -0
  19. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html +0 -0
  20. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html +0 -0
  21. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html +0 -0
  22. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html +0 -0
  23. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html +0 -0
  24. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html +0 -0
  25. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html +0 -0
  26. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html +0 -0
  27. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html +0 -0
  28. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/function.html +0 -0
  29. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/labels.html +0 -0
  30. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html +0 -0
  31. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html +0 -0
  32. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html +0 -0
  33. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/_base/module.html +0 -0
  34. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/attribute.html +0 -0
  35. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/children.html +0 -0
  36. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/class.html +0 -0
  37. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html +0 -0
  38. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html +0 -0
  39. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/classes.html +0 -0
  40. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html +0 -0
  41. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/functions.html +0 -0
  42. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/modules.html +0 -0
  43. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html +0 -0
  44. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html +0 -0
  45. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html +0 -0
  46. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html +0 -0
  47. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html +0 -0
  48. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html +0 -0
  49. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html +0 -0
  50. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/docstring.html +0 -0
  51. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/expression.html +0 -0
  52. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/function.html +0 -0
  53. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/labels.html +0 -0
  54. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/language.html +0 -0
  55. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/languages/en.html +0 -0
  56. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/languages/ja.html +0 -0
  57. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/languages/zh.html +0 -0
  58. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/module.html +0 -0
  59. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/signature.html +0 -0
  60. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/material/style.css +0 -0
  61. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html +0 -0
  62. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html +0 -0
  63. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html +0 -0
  64. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html +0 -0
  65. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html +0 -0
  66. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html +0 -0
  67. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html +0 -0
  68. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html +0 -0
  69. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/language.html +0 -0
  70. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html +0 -0
  71. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html +0 -0
  72. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html +0 -0
  73. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/src/mkdocstrings_handlers/python/templates/readthedocs/style.css +0 -0
  74. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/tests/__init__.py +0 -0
  75. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/tests/conftest.py +0 -0
  76. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/tests/test_handler.py +0 -0
  77. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/tests/test_rendering.py +0 -0
  78. {mkdocstrings_python-1.7.0 → mkdocstrings_python-1.7.1}/tests/test_themes.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocstrings-python
3
- Version: 1.7.0
3
+ Version: 1.7.1
4
4
  Summary: A Python handler for mkdocstrings.
5
5
  Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
6
6
  License: ISC
@@ -35,7 +35,7 @@ dependencies = [
35
35
  "mkdocstrings>=0.20",
36
36
  "griffe>=0.35",
37
37
  ]
38
- version = "1.7.0"
38
+ version = "1.7.1"
39
39
 
40
40
  [project.license]
41
41
  text = "ISC"
@@ -26,8 +26,8 @@
26
26
  {% block heading scoped %}
27
27
  {% if config.separate_signature %}
28
28
  <span class="doc doc-object-name doc-class-name">{{ class_name }}</span>
29
- {% elif config.merge_init_into_class and "__init__" in class.members %}
30
- {% with function = class.members["__init__"] %}
29
+ {% elif config.merge_init_into_class and "__init__" in class.all_members %}
30
+ {% with function = class.all_members["__init__"] %}
31
31
  {%+ filter highlight(language="python", inline=True) %}
32
32
  {{ class_name }}{% include "signature.html" with context %}
33
33
  {% endfilter %}
@@ -47,8 +47,8 @@
47
47
 
48
48
  {% block signature scoped %}
49
49
  {% if config.separate_signature and config.merge_init_into_class %}
50
- {% if "__init__" in class.members %}
51
- {% with function = class.members["__init__"] %}
50
+ {% if "__init__" in class.all_members %}
51
+ {% with function = class.all_members["__init__"] %}
52
52
  {% filter format_signature(function, config.line_length, crossrefs=config.signature_crossrefs) %}
53
53
  {{ class.name }}
54
54
  {% endfilter %}
@@ -86,8 +86,8 @@
86
86
  {% include "docstring.html" with context %}
87
87
  {% endwith %}
88
88
  {% if config.merge_init_into_class %}
89
- {% if "__init__" in class.members and class.members["__init__"].has_docstring %}
90
- {% with docstring_sections = class.members["__init__"].docstring.parsed %}
89
+ {% if "__init__" in class.all_members and class.all_members["__init__"].has_docstring %}
90
+ {% with docstring_sections = class.all_members["__init__"].docstring.parsed %}
91
91
  {% include "docstring.html" with context %}
92
92
  {% endwith %}
93
93
  {% endif %}
@@ -97,10 +97,10 @@
97
97
  {% block source scoped %}
98
98
  {% if config.show_source %}
99
99
  {% if config.merge_init_into_class %}
100
- {% if "__init__" in class.members and class.members["__init__"].source %}
100
+ {% if "__init__" in class.all_members and class.all_members["__init__"].source %}
101
101
  <details class="quote">
102
102
  <summary>Source code in <code>{{ class.relative_filepath }}</code></summary>
103
- {{ class.members["__init__"].source|highlight(language="python", linestart=class.members["__init__"].lineno, linenums=True) }}
103
+ {{ class.all_members["__init__"].source|highlight(language="python", linestart=class.all_members["__init__"].lineno, linenums=True) }}
104
104
  </details>
105
105
  {% endif %}
106
106
  {% elif class.source %}
@@ -11,10 +11,6 @@
11
11
  )
12
12
  -%}
13
13
 
14
- {%- if config.show_signature_annotations -%}
15
- {%- set ns.equal = " = " -%}
16
- {%- endif -%}
17
-
18
14
  (
19
15
  {%- for parameter in function.parameters -%}
20
16
  {%- if parameter.name not in ("self", "cls") or loop.index0 > 0 or not (function.parent and function.parent.is_class) -%}
@@ -31,6 +27,7 @@
31
27
  {%- endif -%}
32
28
 
33
29
  {%- if config.show_signature_annotations and parameter.annotation is not none -%}
30
+ {%- set ns.equal = " = " -%}
34
31
  {%- if config.separate_signature and config.signature_crossrefs -%}
35
32
  {%- with expression = parameter.annotation -%}
36
33
  {%- set ns.annotation -%}: {% include "expression.html" with context %}{%- endset -%}
@@ -38,6 +35,9 @@
38
35
  {%- else -%}
39
36
  {%- set ns.annotation = ": " + parameter.annotation|safe -%}
40
37
  {%- endif -%}
38
+ {%- else -%}
39
+ {%- set ns.equal = "=" -%}
40
+ {%- set ns.annotation = "" -%}
41
41
  {%- endif -%}
42
42
 
43
43
  {%- if parameter.default is not none and parameter.kind.value != "variadic positional" and parameter.kind.value != "variadic keyword" -%}