mkdocstrings-python 1.9.1__tar.gz → 1.10.0__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 (89) hide show
  1. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/PKG-INFO +4 -5
  2. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/pyproject.toml +3 -4
  3. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html +7 -7
  4. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/classes.html +7 -7
  5. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html +1 -1
  6. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/functions.html +7 -7
  7. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/modules.html +7 -7
  8. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html +7 -7
  9. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html +7 -7
  10. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html +7 -7
  11. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html +7 -7
  12. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html +7 -7
  13. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html +7 -7
  14. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html +7 -7
  15. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html +5 -1
  16. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/style.css +5 -0
  17. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/LICENSE +0 -0
  18. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/README.md +0 -0
  19. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/__init__.py +0 -0
  20. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/debug.py +0 -0
  21. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/handler.py +0 -0
  22. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/py.typed +0 -0
  23. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/rendering.py +0 -0
  24. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html +0 -0
  25. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/children.html +0 -0
  26. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/class.html +0 -0
  27. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html +0 -0
  28. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html +0 -0
  29. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/function.html +0 -0
  30. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/labels.html +0 -0
  31. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/en.html +0 -0
  32. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/ja.html +0 -0
  33. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/languages/zh.html +0 -0
  34. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/module.html +0 -0
  35. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html +0 -0
  36. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/attributes.html +0 -0
  37. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/classes.html +0 -0
  38. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/functions.html +0 -0
  39. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary/modules.html +0 -0
  40. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/_base/summary.html +0 -0
  41. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/attribute.html +0 -0
  42. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/children.html +0 -0
  43. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/class.html +0 -0
  44. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html +0 -0
  45. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html +0 -0
  46. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/classes.html +0 -0
  47. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html +0 -0
  48. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/functions.html +0 -0
  49. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/modules.html +0 -0
  50. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html +0 -0
  51. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html +0 -0
  52. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html +0 -0
  53. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html +0 -0
  54. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html +0 -0
  55. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html +0 -0
  56. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html +0 -0
  57. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/docstring.html +0 -0
  58. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/expression.html +0 -0
  59. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/function.html +0 -0
  60. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/labels.html +0 -0
  61. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/language.html +0 -0
  62. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/languages/en.html +0 -0
  63. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/languages/ja.html +0 -0
  64. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/languages/zh.html +0 -0
  65. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/module.html +0 -0
  66. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/signature.html +0 -0
  67. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/summary/attributes.html +0 -0
  68. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/summary/classes.html +0 -0
  69. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/summary/functions.html +0 -0
  70. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/summary/modules.html +0 -0
  71. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/material/summary.html +0 -0
  72. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html +0 -0
  73. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html +0 -0
  74. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html +0 -0
  75. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html +0 -0
  76. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html +0 -0
  77. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html +0 -0
  78. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html +0 -0
  79. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html +0 -0
  80. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/language.html +0 -0
  81. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/en.html +0 -0
  82. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/ja.html +0 -0
  83. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/languages/zh.html +0 -0
  84. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/src/mkdocstrings_handlers/python/templates/readthedocs/style.css +0 -0
  85. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/tests/__init__.py +0 -0
  86. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/tests/conftest.py +0 -0
  87. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/tests/test_handler.py +0 -0
  88. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/tests/test_rendering.py +0 -0
  89. {mkdocstrings_python-1.9.1 → mkdocstrings_python-1.10.0}/tests/test_themes.py +0 -0
@@ -1,8 +1,8 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocstrings-python
3
- Version: 1.9.1
3
+ Version: 1.10.0
4
4
  Summary: A Python handler for mkdocstrings.
5
- Author-Email: Timothée Mazzucotelli <dev@pawamoy.fr>
5
+ Author-Email: =?utf-8?q?Timoth=C3=A9e_Mazzucotelli?= <dev@pawamoy.fr>
6
6
  License: ISC
7
7
  Classifier: Development Status :: 4 - Beta
8
8
  Classifier: Intended Audience :: Developers
@@ -27,9 +27,8 @@ Project-URL: Discussions, https://github.com/mkdocstrings/python/discussions
27
27
  Project-URL: Gitter, https://gitter.im/mkdocstrings/python
28
28
  Project-URL: Funding, https://github.com/sponsors/pawamoy
29
29
  Requires-Python: >=3.8
30
- Requires-Dist: markdown<3.6,>=3.3
31
- Requires-Dist: mkdocstrings>=0.20
32
- Requires-Dist: griffe>=0.37
30
+ Requires-Dist: mkdocstrings>=0.24.2
31
+ Requires-Dist: griffe>=0.44
33
32
  Description-Content-Type: text/markdown
34
33
 
35
34
  <h1 align="center">mkdocstrings-python</h1>
@@ -31,11 +31,10 @@ classifiers = [
31
31
  "Typing :: Typed",
32
32
  ]
33
33
  dependencies = [
34
- "markdown>=3.3,<3.6",
35
- "mkdocstrings>=0.20",
36
- "griffe>=0.37",
34
+ "mkdocstrings>=0.24.2",
35
+ "griffe>=0.44",
37
36
  ]
38
- version = "1.9.1"
37
+ version = "1.10.0"
39
38
 
40
39
  [project.license]
41
40
  text = "ISC"
@@ -4,7 +4,7 @@
4
4
 
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
- <p><strong>{{ section.title or lang.t("Attributes:") }}</strong></p>
7
+ <p><span class="doc-section-title">{{ section.title or lang.t("Attributes:") }}</span></p>
8
8
  <table>
9
9
  <thead>
10
10
  <tr>
@@ -15,7 +15,7 @@
15
15
  </thead>
16
16
  <tbody>
17
17
  {% for attribute in section.value %}
18
- <tr>
18
+ <tr class="doc-section-item">
19
19
  <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></td>
20
20
  <td>
21
21
  {% if attribute.annotation %}
@@ -36,10 +36,10 @@
36
36
  {% endblock table_style %}
37
37
  {% elif config.docstring_section_style == "list" %}
38
38
  {% block list_style scoped %}
39
- <p>{{ section.title or lang.t("Attributes:") }}</p>
39
+ <p><span class="doc-section-title">{{ section.title or lang.t("Attributes:") }}</span></p>
40
40
  <ul>
41
41
  {% for attribute in section.value %}
42
- <li class="field-body">
42
+ <li class="doc-section-item field-body">
43
43
  <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></b>
44
44
  {% if attribute.annotation %}
45
45
  {% with expression = attribute.annotation %}
@@ -59,13 +59,13 @@
59
59
  <table>
60
60
  <thead>
61
61
  <tr>
62
- <th><b>{{ (section.title or lang.t("ATTRIBUTE")).rstrip(":").upper() }}</b></th>
63
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
62
+ <th><span class="doc-section-title">{{ (section.title or lang.t("ATTRIBUTE")).rstrip(":").upper() }}</span></th>
63
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
64
64
  </tr>
65
65
  </thead>
66
66
  <tbody>
67
67
  {% for attribute in section.value %}
68
- <tr>
68
+ <tr class="doc-section-item">
69
69
  <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ attribute.name }}">{{ attribute.name }}</span></code></td>
70
70
  <td class="doc-attribute-details">
71
71
  <div class="doc-md-description">
@@ -4,7 +4,7 @@
4
4
 
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
- <p><strong>{{ section.title or lang.t("Classes:") }}</strong></p>
7
+ <p><span class="doc-section-title">{{ section.title or lang.t("Classes:") }}</span></p>
8
8
  <table>
9
9
  <thead>
10
10
  <tr>
@@ -14,7 +14,7 @@
14
14
  </thead>
15
15
  <tbody>
16
16
  {% for class in section.value %}
17
- <tr>
17
+ <tr class="doc-section-item">
18
18
  <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></td>
19
19
  <td>
20
20
  <div class="doc-md-description">
@@ -28,10 +28,10 @@
28
28
  {% endblock table_style %}
29
29
  {% elif config.docstring_section_style == "list" %}
30
30
  {% block list_style scoped %}
31
- <p>{{ section.title or lang.t("Classes:") }}</p>
31
+ <p><span class="doc-section-title">{{ section.title or lang.t("Classes:") }}</span></p>
32
32
  <ul>
33
33
  {% for class in section.value %}
34
- <li class="field-body">
34
+ <li class="doc-section-item field-body">
35
35
  <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></b>
36
36
  –
37
37
  <div class="doc-md-description">
@@ -46,13 +46,13 @@
46
46
  <table>
47
47
  <thead>
48
48
  <tr>
49
- <th><b>{{ (section.title or lang.t("CLASS")).rstrip(":").upper() }}</b></th>
50
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
49
+ <th><span class="doc-section-title">{{ (section.title or lang.t("CLASS")).rstrip(":").upper() }}</span></th>
50
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
51
51
  </tr>
52
52
  </thead>
53
53
  <tbody>
54
54
  {% for class in section.value %}
55
- <tr>
55
+ <tr class="doc-section-item">
56
56
  <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ class.name }}">{{ class.name }}</span></code></td>
57
57
  <td class="doc-class-details">
58
58
  <div class="doc-md-description">
@@ -2,7 +2,7 @@
2
2
 
3
3
  {% import "language.html" as lang with context %}
4
4
 
5
- <p><strong>{{ section.title or lang.t("Examples:") }}</strong></p>
5
+ <p><span class="doc-section-title">{{ section.title or lang.t("Examples:") }}</span></p>
6
6
  {% for section_type, sub_section in section.value %}
7
7
  {% if section_type.value == "text" %}
8
8
  {{ sub_section|convert_markdown(heading_level, html_id) }}
@@ -4,7 +4,7 @@
4
4
 
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
- <p><strong>{{ section.title or lang.t("Methods:") if obj.is_class else lang.t("Functions:") }}</strong></p>
7
+ <p><span class="doc-section-title">{{ section.title or lang.t("Methods:") if obj.is_class else lang.t("Functions:") }}</span></p>
8
8
  <table>
9
9
  <thead>
10
10
  <tr>
@@ -15,7 +15,7 @@
15
15
  <tbody>
16
16
  {% for function in section.value %}
17
17
  {% if not function.name == "__init__" or not config.merge_init_into_class %}
18
- <tr>
18
+ <tr class="doc-section-item">
19
19
  <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></td>
20
20
  <td>
21
21
  <div class="doc-md-description">
@@ -30,11 +30,11 @@
30
30
  {% endblock table_style %}
31
31
  {% elif config.docstring_section_style == "list" %}
32
32
  {% block list_style scoped %}
33
- <p>{{ section.title or lang.t("Methods:") if obj.is_class else lang.t("Functions:") }}</p>
33
+ <p><span class="doc-section-title">{{ section.title or lang.t("Methods:") if obj.is_class else lang.t("Functions:") }}</span></p>
34
34
  <ul>
35
35
  {% for function in section.value %}
36
36
  {% if not function.name == "__init__" or not config.merge_init_into_class %}
37
- <li class="field-body">
37
+ <li class="doc-section-item field-body">
38
38
  <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></b>
39
39
  –
40
40
  <div class="doc-md-description">
@@ -50,14 +50,14 @@
50
50
  <table>
51
51
  <thead>
52
52
  <tr>
53
- <th><b>{{ (section.title or lang.t("METHOD") if obj.is_class else lang.t("FUNCTION")).rstrip(":").upper() }}</b></th>
54
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
53
+ <th><span class="doc-section-title">{{ (section.title or lang.t("METHOD") if obj.is_class else lang.t("FUNCTION")).rstrip(":").upper() }}</span></th>
54
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
55
55
  </tr>
56
56
  </thead>
57
57
  <tbody>
58
58
  {% for function in section.value %}
59
59
  {% if not function.name == "__init__" or not config.merge_init_into_class %}
60
- <tr>
60
+ <tr class="doc-section-item">
61
61
  <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ function.name }}">{{ function.name }}</span></code></td>
62
62
  <td class="doc-function-details">
63
63
  <div class="doc-md-description">
@@ -4,7 +4,7 @@
4
4
 
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
- <p><strong>{{ section.title or lang.t("Modules:") }}</strong></p>
7
+ <p><span class="doc-section-title">{{ section.title or lang.t("Modules:") }}</span></p>
8
8
  <table>
9
9
  <thead>
10
10
  <tr>
@@ -14,7 +14,7 @@
14
14
  </thead>
15
15
  <tbody>
16
16
  {% for module in section.value %}
17
- <tr>
17
+ <tr class="doc-section-item">
18
18
  <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></td>
19
19
  <td>
20
20
  <div class="doc-md-description">
@@ -28,10 +28,10 @@
28
28
  {% endblock table_style %}
29
29
  {% elif config.docstring_section_style == "list" %}
30
30
  {% block list_style scoped %}
31
- <p>{{ section.title or lang.t("Modules:") }}</p>
31
+ <p><span class="doc-section-title">{{ section.title or lang.t("Modules:") }}</span></p>
32
32
  <ul>
33
33
  {% for module in section.value %}
34
- <li class="field-body">
34
+ <li class="doc-section-item field-body">
35
35
  <b><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></b>
36
36
  –
37
37
  <div class="doc-md-description">
@@ -46,13 +46,13 @@
46
46
  <table>
47
47
  <thead>
48
48
  <tr>
49
- <th><b>{{ (section.title or lang.t("MODULE")).rstrip(":").upper() }}</b></th>
50
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
49
+ <th><span class="doc-section-title">{{ (section.title or lang.t("MODULE")).rstrip(":").upper() }}</span></th>
50
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
51
51
  </tr>
52
52
  </thead>
53
53
  <tbody>
54
54
  {% for module in section.value %}
55
- <tr>
55
+ <tr class="doc-section-item">
56
56
  <td><code><span data-autorefs-optional-hover="{{ obj.path }}.{{ module.name }}">{{ module.name }}</span></code></td>
57
57
  <td class="doc-module-details">
58
58
  <div class="doc-md-description">
@@ -4,7 +4,7 @@
4
4
 
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
- <p><strong>{{ section.title or lang.t("Other Parameters:") }}</strong></p>
7
+ <p><span class="doc-section-title">{{ section.title or lang.t("Other Parameters:") }}</span></p>
8
8
  <table>
9
9
  <thead>
10
10
  <tr>
@@ -15,7 +15,7 @@
15
15
  </thead>
16
16
  <tbody>
17
17
  {% for parameter in section.value %}
18
- <tr>
18
+ <tr class="doc-section-item">
19
19
  <td><code>{{ parameter.name }}</code></td>
20
20
  <td>
21
21
  {% if parameter.annotation %}
@@ -36,10 +36,10 @@
36
36
  {% endblock table_style %}
37
37
  {% elif config.docstring_section_style == "list" %}
38
38
  {% block list_style scoped %}
39
- <p>{{ section.title or lang.t("Other Parameters:") }}</p>
39
+ <p><span class="doc-section-title">{{ section.title or lang.t("Other Parameters:") }}</span></p>
40
40
  <ul>
41
41
  {% for parameter in section.value %}
42
- <li class="field-body">
42
+ <li class="doc-section-item field-body">
43
43
  <b><code>{{ parameter.name }}</code></b>
44
44
  {% if parameter.annotation %}
45
45
  {% with expression = parameter.annotation %}
@@ -59,13 +59,13 @@
59
59
  <table>
60
60
  <thead>
61
61
  <tr>
62
- <th><b>{{ (section.title or lang.t("PARAMETER")).rstrip(":").upper() }}</b></th>
63
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
62
+ <th><span class="doc-section-title">{{ (section.title or lang.t("PARAMETER")).rstrip(":").upper() }}</span></th>
63
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
64
64
  </tr>
65
65
  </thead>
66
66
  <tbody>
67
67
  {% for parameter in section.value %}
68
- <tr>
68
+ <tr class="doc-section-item">
69
69
  <td><code>{{ parameter.name }}</code></td>
70
70
  <td class="doc-param-details">
71
71
  <div class="doc-md-description">
@@ -4,7 +4,7 @@
4
4
 
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
- <p><strong>{{ section.title or lang.t("Parameters:") }}</strong></p>
7
+ <p><span class="doc-section-title">{{ section.title or lang.t("Parameters:") }}</span></p>
8
8
  <table>
9
9
  <thead>
10
10
  <tr>
@@ -16,7 +16,7 @@
16
16
  </thead>
17
17
  <tbody>
18
18
  {% for parameter in section.value %}
19
- <tr>
19
+ <tr class="doc-section-item">
20
20
  <td><code>{{ parameter.name }}</code></td>
21
21
  <td>
22
22
  {% if parameter.annotation %}
@@ -46,10 +46,10 @@
46
46
  {% endblock table_style %}
47
47
  {% elif config.docstring_section_style == "list" %}
48
48
  {% block list_style scoped %}
49
- <p>{{ section.title or lang.t("Parameters:") }}</p>
49
+ <p><span class="doc-section-title">{{ section.title or lang.t("Parameters:") }}</span></p>
50
50
  <ul>
51
51
  {% for parameter in section.value %}
52
- <li class="field-body">
52
+ <li class="doc-section-item field-body">
53
53
  <b><code>{{ parameter.name }}</code></b>
54
54
  {% if parameter.annotation %}
55
55
  {% with expression = parameter.annotation %}
@@ -74,13 +74,13 @@
74
74
  <table>
75
75
  <thead>
76
76
  <tr>
77
- <th><b>{{ (section.title or lang.t("PARAMETER")).rstrip(":").upper() }}</b></th>
78
- <th><b> {{ lang.t("DESCRIPTION") }}</b></th>
77
+ <th><span class="doc-section-title">{{ (section.title or lang.t("PARAMETER")).rstrip(":").upper() }}</span></th>
78
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
79
79
  </tr>
80
80
  </thead>
81
81
  <tbody>
82
82
  {% for parameter in section.value %}
83
- <tr>
83
+ <tr class="doc-section-item">
84
84
  <td><code>{{ parameter.name }}</code></td>
85
85
  <td class="doc-param-details">
86
86
  <div class="doc-md-description">
@@ -4,7 +4,7 @@
4
4
 
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
- <p><strong>{{ section.title or lang.t("Raises:") }}</strong></p>
7
+ <p><span class="doc-section-title">{{ section.title or lang.t("Raises:") }}</span></p>
8
8
  <table>
9
9
  <thead>
10
10
  <tr>
@@ -14,7 +14,7 @@
14
14
  </thead>
15
15
  <tbody>
16
16
  {% for raises in section.value %}
17
- <tr>
17
+ <tr class="doc-section-item">
18
18
  <td>
19
19
  {% if raises.annotation %}
20
20
  {% with expression = raises.annotation %}
@@ -34,10 +34,10 @@
34
34
  {% endblock table_style %}
35
35
  {% elif config.docstring_section_style == "list" %}
36
36
  {% block list_style scoped %}
37
- <p>{{ lang.t(section.title) or lang.t("Raises:") }}</p>
37
+ <p><span class="doc-section-title">{{ lang.t(section.title) or lang.t("Raises:") }}</span></p>
38
38
  <ul>
39
39
  {% for raises in section.value %}
40
- <li class="field-body">
40
+ <li class="doc-section-item field-body">
41
41
  {% if raises.annotation %}
42
42
  {% with expression = raises.annotation %}
43
43
  <code>{% include "expression.html" with context %}</code>
@@ -56,13 +56,13 @@
56
56
  <table>
57
57
  <thead>
58
58
  <tr>
59
- <th><b>{{ (section.title or lang.t("RAISES")).rstrip(":").upper() }}</b></th>
60
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
59
+ <th><span class="doc-section-title">{{ (section.title or lang.t("RAISES")).rstrip(":").upper() }}</span></th>
60
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
61
61
  </tr>
62
62
  </thead>
63
63
  <tbody>
64
64
  {% for raises in section.value %}
65
- <tr>
65
+ <tr class="doc-section-item">
66
66
  <td>
67
67
  <span class="doc-raises-annotation">
68
68
  {% with expression = raises.annotation %}
@@ -5,7 +5,7 @@
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
7
  {% set name_column = section.value|selectattr("name")|any %}
8
- <p><strong>{{ section.title or lang.t("Receives:") }}</strong></p>
8
+ <p><span class="doc-section-title">{{ section.title or lang.t("Receives:") }}</span></p>
9
9
  <table>
10
10
  <thead>
11
11
  <tr>
@@ -16,7 +16,7 @@
16
16
  </thead>
17
17
  <tbody>
18
18
  {% for receives in section.value %}
19
- <tr>
19
+ <tr class="doc-section-item">
20
20
  {% if name_column %}<td>{% if receives.name %}<code>{{ receives.name }}</code>{% endif %}</td>{% endif %}
21
21
  <td>
22
22
  {% if receives.annotation %}
@@ -37,10 +37,10 @@
37
37
  {% endblock table_style %}
38
38
  {% elif config.docstring_section_style == "list" %}
39
39
  {% block list_style scoped %}
40
- <p>{{ section.title or lang.t("Receives:") }}</p>
40
+ <p><span class="doc-section-title">{{ section.title or lang.t("Receives:") }}</span></p>
41
41
  <ul>
42
42
  {% for receives in section.value %}
43
- <li class="field-body">
43
+ <li class="doc-section-item field-body">
44
44
  {% if receives.name %}<b><code>{{ receives.name }}</code></b>{% endif %}
45
45
  {% if receives.annotation %}
46
46
  {% with expression = receives.annotation %}
@@ -62,13 +62,13 @@
62
62
  <table>
63
63
  <thead>
64
64
  <tr>
65
- <th><b>{{ (section.title or lang.t("RECEIVES")).rstrip(":").upper() }}</b></th>
66
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
65
+ <th><span class="doc-section-title">{{ (section.title or lang.t("RECEIVES")).rstrip(":").upper() }}</span></th>
66
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
67
67
  </tr>
68
68
  </thead>
69
69
  <tbody>
70
70
  {% for receives in section.value %}
71
- <tr>
71
+ <tr class="doc-section-item">
72
72
  <td>
73
73
  {% if receives.name %}
74
74
  <code>{{ receives.name }}</code>
@@ -5,7 +5,7 @@
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
7
  {% set name_column = section.value|selectattr("name")|any %}
8
- <p><strong>{{ section.title or lang.t("Returns:") }}</strong></p>
8
+ <p><span class="doc-section-title">{{ section.title or lang.t("Returns:") }}</span></p>
9
9
  <table>
10
10
  <thead>
11
11
  <tr>
@@ -16,7 +16,7 @@
16
16
  </thead>
17
17
  <tbody>
18
18
  {% for returns in section.value %}
19
- <tr>
19
+ <tr class="doc-section-item">
20
20
  {% if name_column %}<td>{% if returns.name %}<code>{{ returns.name }}</code>{% endif %}</td>{% endif %}
21
21
  <td>
22
22
  {% if returns.annotation %}
@@ -37,10 +37,10 @@
37
37
  {% endblock table_style %}
38
38
  {% elif config.docstring_section_style == "list" %}
39
39
  {% block list_style scoped %}
40
- <p>{{ section.title or lang.t("Returns:") }}</p>
40
+ <p><span class="doc-section-title">{{ section.title or lang.t("Returns:") }}</span></p>
41
41
  <ul>
42
42
  {% for returns in section.value %}
43
- <li class="field-body">
43
+ <li class="doc-section-item field-body">
44
44
  {% if returns.name %}<b><code>{{ returns.name }}</code></b>{% endif %}
45
45
  {% if returns.annotation %}
46
46
  {% with expression = returns.annotation %}
@@ -62,13 +62,13 @@
62
62
  <table>
63
63
  <thead>
64
64
  <tr>
65
- <th><b>{{ (section.title or lang.t("RETURNS")).rstrip(":").upper() }}</b></th>
66
- <th><b>{{ lang.t("DESCRIPTION").upper() }}</b></th>
65
+ <th><span class="doc-section-title">{{ (section.title or lang.t("RETURNS")).rstrip(":").upper() }}</span></th>
66
+ <th><span>{{ lang.t("DESCRIPTION").upper() }}</span></th>
67
67
  </tr>
68
68
  </thead>
69
69
  <tbody>
70
70
  {% for returns in section.value %}
71
- <tr>
71
+ <tr class="doc-section-item">
72
72
  <td>
73
73
  {% if returns.name %}
74
74
  <code>{{ returns.name }}</code>
@@ -4,7 +4,7 @@
4
4
 
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
- <p><strong>{{ section.title or lang.t("Warns:") }}</strong></p>
7
+ <p><span class="doc-section-title">{{ section.title or lang.t("Warns:") }}</span></p>
8
8
  <table>
9
9
  <thead>
10
10
  <tr>
@@ -14,7 +14,7 @@
14
14
  </thead>
15
15
  <tbody>
16
16
  {% for warns in section.value %}
17
- <tr>
17
+ <tr class="doc-section-item">
18
18
  <td>
19
19
  {% if warns.annotation %}
20
20
  {% with expression = warns.annotation %}
@@ -34,10 +34,10 @@
34
34
  {% endblock table_style %}
35
35
  {% elif config.docstring_section_style == "list" %}
36
36
  {% block list_style scoped %}
37
- <p>{{ section.title or lang.t("Warns:") }}</p>
37
+ <p><span class="doc-section-title">{{ section.title or lang.t("Warns:") }}</span></p>
38
38
  <ul>
39
39
  {% for warns in section.value %}
40
- <li class="field-body">
40
+ <li class="doc-section-item field-body">
41
41
  {% if warns.annotation %}
42
42
  {% with expression = warns.annotation %}
43
43
  <code>{% include "expression.html" with context %}</code>
@@ -56,13 +56,13 @@
56
56
  <table>
57
57
  <thead>
58
58
  <tr>
59
- <th><b>{{ (section.title or lang.t("WARNS")).rstrip(":").upper() }}</b></th>
60
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
59
+ <th><span class="doc-section-title">{{ (section.title or lang.t("WARNS")).rstrip(":").upper() }}</span></th>
60
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
61
61
  </tr>
62
62
  </thead>
63
63
  <tbody>
64
64
  {% for warns in section.value %}
65
- <tr>
65
+ <tr class="doc-section-item">
66
66
  <td>
67
67
  <span class="doc-warns-annotation">
68
68
  {% with expression = warns.annotation %}
@@ -5,7 +5,7 @@
5
5
  {% if config.docstring_section_style == "table" %}
6
6
  {% block table_style scoped %}
7
7
  {% set name_column = section.value|selectattr("name")|any %}
8
- <p><strong>{{ section.title or lang.t("Yields:") }}</strong></p>
8
+ <p><span class="doc-section-title">{{ section.title or lang.t("Yields:") }}</span></p>
9
9
  <table>
10
10
  <thead>
11
11
  <tr>
@@ -16,7 +16,7 @@
16
16
  </thead>
17
17
  <tbody>
18
18
  {% for yields in section.value %}
19
- <tr>
19
+ <tr class="doc-section-item">
20
20
  {% if name_column %}<td>{% if yields.name %}<code>{{ yields.name }}</code>{% endif %}</td>{% endif %}
21
21
  <td>
22
22
  {% if yields.annotation %}
@@ -37,10 +37,10 @@
37
37
  {% endblock table_style %}
38
38
  {% elif config.docstring_section_style == "list" %}
39
39
  {% block list_style scoped %}
40
- <p>{{ section.title or lang.t("Yields:") }}</p>
40
+ <p><span class="doc-section-title">{{ section.title or lang.t("Yields:") }}</span></p>
41
41
  <ul>
42
42
  {% for yields in section.value %}
43
- <li class="field-body">
43
+ <li class="doc-section-item field-body">
44
44
  {% if yields.name %}<b><code>{{ yields.name }}</code></b>{% endif %}
45
45
  {% if yields.annotation %}
46
46
  {% with expression = yields.annotation %}
@@ -62,13 +62,13 @@
62
62
  <table>
63
63
  <thead>
64
64
  <tr>
65
- <th><b>{{ (section.title or lang.t("YIELDS")).rstrip(":").upper() }}</b></th>
66
- <th><b>{{ lang.t("DESCRIPTION") }}</b></th>
65
+ <th><span class="doc-section-title">{{ (section.title or lang.t("YIELDS")).rstrip(":").upper() }}</span></th>
66
+ <th><span>{{ lang.t("DESCRIPTION") }}</span></th>
67
67
  </tr>
68
68
  </thead>
69
69
  <tbody>
70
70
  {% for yields in section.value %}
71
- <tr>
71
+ <tr class="doc-section-item">
72
72
  <td>
73
73
  {% if yields.name %}
74
74
  <code>{{ yields.name }}</code>
@@ -29,7 +29,11 @@
29
29
  {{ render(expression.slice.elements[0], annotations_path) }}
30
30
  {%- elif expression.classname == "ExprAttribute" -%}
31
31
  {%- if annotations_path == "brief" -%}
32
- {{ render(expression.last, "brief") }}
32
+ {%- if expression.last.is_enum_value -%}
33
+ {{ crossref(expression.last.parent, "brief") }}.value
34
+ {%- else -%}
35
+ {{ render(expression.last, "brief") }}
36
+ {%- endif -%}
33
37
  {%- elif annotations_path == "full" -%}
34
38
  {{ render(expression.first, "full") }}
35
39
  {%- for element in expression -%}
@@ -25,6 +25,11 @@
25
25
  float: right;
26
26
  }
27
27
 
28
+ /* Backward-compatibility: docstring section titles in bold. */
29
+ .doc-section-title {
30
+ font-weight: bold;
31
+ }
32
+
28
33
  /* Symbols in Navigation and ToC. */
29
34
  :root,
30
35
  [data-md-color-scheme="default"] {