mkdocstrings-python 1.1.0__py3-none-any.whl → 1.1.1__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 (33) hide show
  1. mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html +12 -3
  2. mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html +12 -3
  3. mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html +12 -3
  4. mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html +11 -3
  5. mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html +12 -3
  6. mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html +12 -3
  7. mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html +11 -3
  8. mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html +12 -3
  9. mkdocstrings_handlers/python/templates/material/style.css +6 -10
  10. mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html +30 -0
  11. mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html +30 -0
  12. mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html +30 -0
  13. mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html +29 -0
  14. mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html +32 -0
  15. mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html +32 -0
  16. mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html +29 -0
  17. mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html +32 -0
  18. mkdocstrings_handlers/python/templates/readthedocs/style.css +34 -5
  19. {mkdocstrings_python-1.1.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/METADATA +1 -1
  20. {mkdocstrings_python-1.1.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/RECORD +22 -25
  21. mkdocstrings_handlers/python/templates/mkdocs/exceptions.html +0 -7
  22. mkdocstrings_handlers/python/templates/mkdocs/keyword_args.html +0 -7
  23. mkdocstrings_handlers/python/templates/mkdocs/parameters.html +0 -7
  24. mkdocstrings_handlers/python/templates/mkdocs/return.html +0 -5
  25. mkdocstrings_handlers/python/templates/mkdocs/style.css +0 -11
  26. mkdocstrings_handlers/python/templates/mkdocs/yield.html +0 -5
  27. mkdocstrings_handlers/python/templates/readthedocs/exceptions.html +0 -19
  28. mkdocstrings_handlers/python/templates/readthedocs/other_parameters.html +0 -19
  29. mkdocstrings_handlers/python/templates/readthedocs/parameters.html +0 -19
  30. mkdocstrings_handlers/python/templates/readthedocs/returns.html +0 -17
  31. mkdocstrings_handlers/python/templates/readthedocs/yields.html +0 -17
  32. {mkdocstrings_python-1.1.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/WHEEL +0 -0
  33. {mkdocstrings_python-1.1.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/licenses/LICENSE +0 -0
mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html CHANGED
@@ -21,7 +21,11 @@
21
21
  {% endwith %}
22
22
  {% endif %}
23
23
  </td>
24
- <td>{{ attribute.description|convert_markdown(heading_level, html_id) }}</td>
24
+ <td>
25
+ <div class="doc-md-description">
26
+ {{ attribute.description|convert_markdown(heading_level, html_id) }}
27
+ </div>
28
+ </td>
25
29
  </tr>
26
30
  {% endfor %}
27
31
  </tbody>
@@ -39,7 +43,10 @@
39
43
  (<code>{% include "expression.html" with context %}</code>)
40
44
  {% endwith %}
41
45
  {% endif %}
42
- – {{ attribute.description|convert_markdown(heading_level, html_id) }}
46
+ –
47
+ <div class="doc-md-description">
48
+ {{ attribute.description|convert_markdown(heading_level, html_id) }}
49
+ </div>
43
50
  </li>
44
51
  {% endfor %}
45
52
  </ul>
@@ -58,7 +65,9 @@
58
65
  <tr>
59
66
  <td><code>{{ attribute.name }}</code></td>
60
67
  <td class="doc-attribute-details">
61
- {{ attribute.description|convert_markdown(heading_level, html_id) }}
68
+ <div class="doc-md-description">
69
+ {{ attribute.description|convert_markdown(heading_level, html_id) }}
70
+ </div>
62
71
  <p>
63
72
  {% if attribute.annotation %}
64
73
  <span class="doc-attribute-annotation">
mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html CHANGED
@@ -21,7 +21,11 @@
21
21
  {% endwith %}
22
22
  {% endif %}
23
23
  </td>
24
- <td>{{ parameter.description|convert_markdown(heading_level, html_id) }}</td>
24
+ <td>
25
+ <div class="doc-md-description">
26
+ {{ parameter.description|convert_markdown(heading_level, html_id) }}
27
+ </div>
28
+ </td>
25
29
  </tr>
26
30
  {% endfor %}
27
31
  </tbody>
@@ -39,7 +43,10 @@
39
43
  (<code>{% include "expression.html" with context %}</code>)
40
44
  {% endwith %}
41
45
  {% endif %}
42
- – {{ parameter.description|convert_markdown(heading_level, html_id) }}
46
+ –
47
+ <div class="doc-md-description">
48
+ {{ parameter.description|convert_markdown(heading_level, html_id) }}
49
+ </div>
43
50
  </li>
44
51
  {% endfor %}
45
52
  </ul>
@@ -58,7 +65,9 @@
58
65
  <tr>
59
66
  <td><code>{{ parameter.name }}</code></td>
60
67
  <td class="doc-param-details">
61
- {{ parameter.description|convert_markdown(heading_level, html_id) }}
68
+ <div class="doc-md-description">
69
+ {{ parameter.description|convert_markdown(heading_level, html_id) }}
70
+ </div>
62
71
  <p>
63
72
  {% if parameter.annotation %}
64
73
  <span class="doc-param-annotation">
mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html CHANGED
@@ -22,7 +22,11 @@
22
22
  {% endwith %}
23
23
  {% endif %}
24
24
  </td>
25
- <td>{{ parameter.description|convert_markdown(heading_level, html_id) }}</td>
25
+ <td>
26
+ <div class="doc-md-description">
27
+ {{ parameter.description|convert_markdown(heading_level, html_id) }}
28
+ </div>
29
+ </td>
26
30
  <td>
27
31
  {% if parameter.default %}
28
32
  {% with expression = parameter.default %}
@@ -49,7 +53,10 @@
49
53
  (<code>{% include "expression.html" with context %}</code>)
50
54
  {% endwith %}
51
55
  {% endif %}
52
- – {{ parameter.description|convert_markdown(heading_level, html_id) }}
56
+ –
57
+ <div class="doc-md-description">
58
+ {{ parameter.description|convert_markdown(heading_level, html_id) }}
59
+ </div>
53
60
  </li>
54
61
  {% endfor %}
55
62
  </ul>
@@ -68,7 +75,9 @@
68
75
  <tr>
69
76
  <td><code>{{ parameter.name }}</code></td>
70
77
  <td class="doc-param-details">
71
- {{ parameter.description|convert_markdown(heading_level, html_id) }}
78
+ <div class="doc-md-description">
79
+ {{ parameter.description|convert_markdown(heading_level, html_id) }}
80
+ </div>
72
81
  <p>
73
82
  {% if parameter.annotation %}
74
83
  <span class="doc-param-annotation">
mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html CHANGED
@@ -19,7 +19,11 @@
19
19
  {% endwith %}
20
20
  {% endif %}
21
21
  </td>
22
- <td>{{ raises.description|convert_markdown(heading_level, html_id) }}</td>
22
+ <td>
23
+ <div class="doc-md-description">
24
+ {{ raises.description|convert_markdown(heading_level, html_id) }}
25
+ </div>
26
+ </td>
23
27
  </tr>
24
28
  {% endfor %}
25
29
  </tbody>
@@ -37,7 +41,9 @@
37
41
  {% endwith %}
38
42
  –
39
43
  {% endif %}
40
- {{ raises.description|convert_markdown(heading_level, html_id) }}
44
+ <div class="doc-md-description">
45
+ {{ raises.description|convert_markdown(heading_level, html_id) }}
46
+ </div>
41
47
  </li>
42
48
  {% endfor %}
43
49
  </ul>
@@ -62,7 +68,9 @@
62
68
  </span>
63
69
  </td>
64
70
  <td class="doc-raises-details">
65
- {{ raises.description|convert_markdown(heading_level, html_id) }}
71
+ <div class="doc-md-description">
72
+ {{ raises.description|convert_markdown(heading_level, html_id) }}
73
+ </div>
66
74
  </td>
67
75
  </tr>
68
76
  {% endfor %}
mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html CHANGED
@@ -22,7 +22,11 @@
22
22
  {% endwith %}
23
23
  {% endif %}
24
24
  </td>
25
- <td>{{ receives.description|convert_markdown(heading_level, html_id) }}</td>
25
+ <td>
26
+ <div class="doc-md-description">
27
+ {{ receives.description|convert_markdown(heading_level, html_id) }}
28
+ </div>
29
+ </td>
26
30
  </tr>
27
31
  {% endfor %}
28
32
  </tbody>
@@ -42,7 +46,10 @@
42
46
  {% if receives.name %}){% endif %}
43
47
  {% endwith %}
44
48
  {% endif %}
45
- – {{ receives.description|convert_markdown(heading_level, html_id) }}
49
+ –
50
+ <div class="doc-md-description">
51
+ {{ receives.description|convert_markdown(heading_level, html_id) }}
52
+ </div>
46
53
  </li>
47
54
  {% endfor %}
48
55
  </ul>
@@ -71,7 +78,9 @@
71
78
  {% endif %}
72
79
  </td>
73
80
  <td class="doc-receives-details">
74
- {{ receives.description|convert_markdown(heading_level, html_id) }}
81
+ <div class="doc-md-description">
82
+ {{ receives.description|convert_markdown(heading_level, html_id) }}
83
+ </div>
75
84
  {% if receives.name and receives.annotation %}
76
85
  <p>
77
86
  <span class="doc-receives-annotation">
mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html CHANGED
@@ -22,7 +22,11 @@
22
22
  {% endwith %}
23
23
  {% endif %}
24
24
  </td>
25
- <td>{{ returns.description|convert_markdown(heading_level, html_id) }}</td>
25
+ <td>
26
+ <div class="doc-md-description">
27
+ {{ returns.description|convert_markdown(heading_level, html_id) }}
28
+ </div>
29
+ </td>
26
30
  </tr>
27
31
  {% endfor %}
28
32
  </tbody>
@@ -42,7 +46,10 @@
42
46
  {% if returns.name %}){% endif %}
43
47
  {% endwith %}
44
48
  {% endif %}
45
- – {{ returns.description|convert_markdown(heading_level, html_id) }}
49
+ –
50
+ <div class="doc-md-description">
51
+ {{ returns.description|convert_markdown(heading_level, html_id) }}
52
+ </div>
46
53
  </li>
47
54
  {% endfor %}
48
55
  </ul>
@@ -71,7 +78,9 @@
71
78
  {% endif %}
72
79
  </td>
73
80
  <td class="doc-returns-details">
74
- {{ returns.description|convert_markdown(heading_level, html_id) }}
81
+ <div class="doc-md-description">
82
+ {{ returns.description|convert_markdown(heading_level, html_id) }}
83
+ </div>
75
84
  {% if returns.name and returns.annotation %}
76
85
  <p>
77
86
  <span class="doc-returns-annotation">
mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html CHANGED
@@ -19,7 +19,11 @@
19
19
  {% endwith %}
20
20
  {% endif %}
21
21
  </td>
22
- <td>{{ warns.description|convert_markdown(heading_level, html_id) }}</td>
22
+ <td>
23
+ <div class="doc-md-description">
24
+ {{ warns.description|convert_markdown(heading_level, html_id) }}
25
+ </div>
26
+ </td>
23
27
  </tr>
24
28
  {% endfor %}
25
29
  </tbody>
@@ -37,7 +41,9 @@
37
41
  {% endwith %}
38
42
  –
39
43
  {% endif %}
40
- {{ warns.description|convert_markdown(heading_level, html_id) }}
44
+ <div class="doc-md-description">
45
+ {{ warns.description|convert_markdown(heading_level, html_id) }}
46
+ </div>
41
47
  </li>
42
48
  {% endfor %}
43
49
  </ul>
@@ -62,7 +68,9 @@
62
68
  </span>
63
69
  </td>
64
70
  <td class="doc-warns-details">
65
- {{ warns.description|convert_markdown(heading_level, html_id) }}
71
+ <div class="doc-md-description">
72
+ {{ warns.description|convert_markdown(heading_level, html_id) }}
73
+ </div>
66
74
  </td>
67
75
  </tr>
68
76
  {% endfor %}
mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html CHANGED
@@ -22,7 +22,11 @@
22
22
  {% endwith %}
23
23
  {% endif %}
24
24
  </td>
25
- <td>{{ yields.description|convert_markdown(heading_level, html_id) }}</td>
25
+ <td>
26
+ <div class="doc-md-description">
27
+ {{ yields.description|convert_markdown(heading_level, html_id) }}
28
+ </div>
29
+ </td>
26
30
  </tr>
27
31
  {% endfor %}
28
32
  </tbody>
@@ -42,7 +46,10 @@
42
46
  {% if yields.name %}){% endif %}
43
47
  {% endwith %}
44
48
  {% endif %}
45
- – {{ yields.description|convert_markdown(heading_level, html_id) }}
49
+ –
50
+ <div class="doc-md-description">
51
+ {{ yields.description|convert_markdown(heading_level, html_id) }}
52
+ </div>
46
53
  </li>
47
54
  {% endfor %}
48
55
  </ul>
@@ -71,7 +78,9 @@
71
78
  {% endif %}
72
79
  </td>
73
80
  <td class="doc-yields-details">
74
- {{ yields.description|convert_markdown(heading_level, html_id) }}
81
+ <div class="doc-md-description">
82
+ {{ yields.description|convert_markdown(heading_level, html_id) }}
83
+ </div>
75
84
  {% if yields.name and yields.annotation %}
76
85
  <p>
77
86
  <span class="doc-yields-annotation">
mkdocstrings_handlers/python/templates/material/style.css CHANGED
@@ -8,10 +8,10 @@ h5.doc-heading {
8
8
  word-break: normal !important;
9
9
  }
10
10
 
11
- /* For pieces of Markdown rendered in table cells. */
12
- .doc-contents td p {
13
- margin-top: 0 !important;
14
- margin-bottom: 0 !important;
11
+ /* No line break before first paragraph of descriptions. */
12
+ .doc-md-description,
13
+ .doc-md-description>p:first-child {
14
+ display: inline;
15
15
  }
16
16
 
17
17
  /* Max width for docstring sections tables. */
@@ -20,16 +20,12 @@ h5.doc-heading {
20
20
  display: table !important;
21
21
  width: 100%;
22
22
  }
23
+
23
24
  .doc .md-typeset__table tr {
24
25
  display: table-row;
25
26
  }
26
27
 
27
- /* Avoid line breaks in rendered fields. */
28
- .field-body p {
29
- display: inline;
30
- }
31
-
32
28
  /* Defaults in Spacy table style. */
33
29
  .doc-param-default {
34
30
  float: right;
35
- }
31
+ }
mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html ADDED
@@ -0,0 +1,30 @@
1
+ {{ log.debug() }}
2
+ <table class="field-list">
3
+ <colgroup>
4
+ <col class="field-name" />
5
+ <col class="field-body" />
6
+ </colgroup>
7
+ <tbody valign="top">
8
+ <tr class="field">
9
+ <th class="field-name">{{ section.title or "Attributes:" }}</th>
10
+ <td class="field-body">
11
+ <ul class="first simple">
12
+ {% for attribute in section.value %}
13
+ <li>
14
+ <b>{{ attribute.name }}</b>
15
+ {% if attribute.annotation %}
16
+ {% with expression = attribute.annotation %}
17
+ (<code>{% include "expression.html" with context %}</code>)
18
+ {% endwith %}
19
+ {% endif %}
20
+ –
21
+ <div class="doc-md-description">
22
+ {{ attribute.description|convert_markdown(heading_level, html_id) }}
23
+ </div>
24
+ </li>
25
+ {% endfor %}
26
+ </ul>
27
+ </td>
28
+ </tr>
29
+ </tbody>
30
+ </table>
mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html ADDED
@@ -0,0 +1,30 @@
1
+ {{ log.debug() }}
2
+ <table class="field-list">
3
+ <colgroup>
4
+ <col class="field-name" />
5
+ <col class="field-body" />
6
+ </colgroup>
7
+ <tbody valign="top">
8
+ <tr class="field">
9
+ <th class="field-name">{{ section.title or "Other parameters:" }}</th>
10
+ <td class="field-body">
11
+ <ul class="first simple">
12
+ {% for parameter in section.value %}
13
+ <li>
14
+ <b>{{ parameter.name }}</b>
15
+ {% if parameter.annotation %}
16
+ {% with expression = parameter.annotation %}
17
+ (<code>{% include "expression.html" with context %}</code>)
18
+ {% endwith %}
19
+ {% endif %}
20
+ –
21
+ <div class="doc-md-description">
22
+ {{ parameter.description|convert_markdown(heading_level, html_id) }}
23
+ </div>
24
+ </li>
25
+ {% endfor %}
26
+ </ul>
27
+ </td>
28
+ </tr>
29
+ </tbody>
30
+ </table>
mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html ADDED
@@ -0,0 +1,30 @@
1
+ {{ log.debug() }}
2
+ <table class="field-list">
3
+ <colgroup>
4
+ <col class="field-name" />
5
+ <col class="field-body" />
6
+ </colgroup>
7
+ <tbody valign="top">
8
+ <tr class="field">
9
+ <th class="field-name">{{ section.title or "Parameters:" }}</th>
10
+ <td class="field-body">
11
+ <ul class="first simple">
12
+ {% for parameter in section.value %}
13
+ <li>
14
+ <b>{{ parameter.name }}</b>
15
+ {% if parameter.annotation %}
16
+ {% with expression = parameter.annotation %}
17
+ (<code>{% include "expression.html" with context %}</code>)
18
+ {% endwith %}
19
+ {% endif %}
20
+ –
21
+ <div class="doc-md-description">
22
+ {{ parameter.description|convert_markdown(heading_level, html_id) }}
23
+ </div>
24
+ </li>
25
+ {% endfor %}
26
+ </ul>
27
+ </td>
28
+ </tr>
29
+ </tbody>
30
+ </table>
mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html ADDED
@@ -0,0 +1,29 @@
1
+ {{ log.debug() }}
2
+ <table class="field-list">
3
+ <colgroup>
4
+ <col class="field-name" />
5
+ <col class="field-body" />
6
+ </colgroup>
7
+ <tbody valign="top">
8
+ <tr class="field">
9
+ <th class="field-name">{{ section.title or "Raises:" }}</th>
10
+ <td class="field-body">
11
+ <ul class="first simple">
12
+ {% for raises in section.value %}
13
+ <li>
14
+ {% if raises.annotation %}
15
+ {% with expression = raises.annotation %}
16
+ <code>{% include "expression.html" with context %}</code>
17
+ {% endwith %}
18
+ {% endif %}
19
+ –
20
+ <div class="doc-md-description">
21
+ {{ raises.description|convert_markdown(heading_level, html_id) }}
22
+ </div>
23
+ </li>
24
+ {% endfor %}
25
+ </ul>
26
+ </td>
27
+ </tr>
28
+ </tbody>
29
+ </table>
mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html ADDED
@@ -0,0 +1,32 @@
1
+ {{ log.debug() }}
2
+ <table class="field-list">
3
+ <colgroup>
4
+ <col class="field-name" />
5
+ <col class="field-body" />
6
+ </colgroup>
7
+ <tbody valign="top">
8
+ <tr class="field">
9
+ <th class="field-name">{{ section.title or "Receives:" }}</th>
10
+ <td class="field-body">
11
+ <ul class="first simple">
12
+ {% for receives in section.value %}
13
+ <li>
14
+ {% if receives.name %}<b>{{ receives.name }}</b>{% endif %}
15
+ {% if receives.annotation %}
16
+ {% with expression = receives.annotation %}
17
+ {% if receives.name %}({% endif %}
18
+ <code>{% include "expression.html" with context %}</code>
19
+ {% if receives.name %}){% endif %}
20
+ {% endwith %}
21
+ {% endif %}
22
+ –
23
+ <div class="doc-md-description">
24
+ {{ receives.description|convert_markdown(heading_level, html_id) }}
25
+ </div>
26
+ </li>
27
+ {% endfor %}
28
+ </ul>
29
+ </td>
30
+ </tr>
31
+ </tbody>
32
+ </table>
mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html ADDED
@@ -0,0 +1,32 @@
1
+ {{ log.debug() }}
2
+ <table class="field-list">
3
+ <colgroup>
4
+ <col class="field-name" />
5
+ <col class="field-body" />
6
+ </colgroup>
7
+ <tbody valign="top">
8
+ <tr class="field">
9
+ <th class="field-name">{{ section.title or "Returns:" }}</th>
10
+ <td class="field-body">
11
+ <ul class="first simple">
12
+ {% for returns in section.value %}
13
+ <li>
14
+ {% if returns.name %}<b>{{ returns.name }}</b>{% endif %}
15
+ {% if returns.annotation %}
16
+ {% with expression = returns.annotation %}
17
+ {% if returns.name %}({% endif %}
18
+ <code>{% include "expression.html" with context %}</code>
19
+ {% if returns.name %}){% endif %}
20
+ {% endwith %}
21
+ {% endif %}
22
+ –
23
+ <div class="doc-md-description">
24
+ {{ returns.description|convert_markdown(heading_level, html_id) }}
25
+ </div>
26
+ </li>
27
+ {% endfor %}
28
+ </ul>
29
+ </td>
30
+ </tr>
31
+ </tbody>
32
+ </table>
mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html ADDED
@@ -0,0 +1,29 @@
1
+ {{ log.debug() }}
2
+ <table class="field-list">
3
+ <colgroup>
4
+ <col class="field-name" />
5
+ <col class="field-body" />
6
+ </colgroup>
7
+ <tbody valign="top">
8
+ <tr class="field">
9
+ <th class="field-name">{{ section.title or "Warns:" }}</th>
10
+ <td class="field-body">
11
+ <ul class="first simple">
12
+ {% for warns in section.value %}
13
+ <li>
14
+ {% if warns.annotation %}
15
+ {% with expression = warns.annotation %}
16
+ <code>{% include "expression.html" with context %}</code>
17
+ {% endwith %}
18
+ {% endif %}
19
+ –
20
+ <div class="doc-md-description">
21
+ {{ warns.description|convert_markdown(heading_level, html_id) }}
22
+ </div>
23
+ </li>
24
+ {% endfor %}
25
+ </ul>
26
+ </td>
27
+ </tr>
28
+ </tbody>
29
+ </table>
mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html ADDED
@@ -0,0 +1,32 @@
1
+ {{ log.debug() }}
2
+ <table class="field-list">
3
+ <colgroup>
4
+ <col class="field-name" />
5
+ <col class="field-body" />
6
+ </colgroup>
7
+ <tbody valign="top">
8
+ <tr class="field">
9
+ <th class="field-name">{{ section.title or "Yields:" }}</th>
10
+ <td class="field-body">
11
+ <ul class="first simple">
12
+ {% for yields in section.value %}
13
+ <li>
14
+ {% if yields.name %}<b>{{ yields.name }}</b>{% endif %}
15
+ {% if yields.annotation %}
16
+ {% with expression = yields.annotation %}
17
+ {% if yields.name %}({% endif %}
18
+ <code>{% include "expression.html" with context %}</code>
19
+ {% if yields.name %}){% endif %}
20
+ {% endwith %}
21
+ {% endif %}
22
+ –
23
+ <div class="doc-md-description">
24
+ {{ yields.description|convert_markdown(heading_level, html_id) }}
25
+ </div>
26
+ </li>
27
+ {% endfor %}
28
+ </ul>
29
+ </td>
30
+ </tr>
31
+ </tbody>
32
+ </table>
mkdocstrings_handlers/python/templates/readthedocs/style.css CHANGED
@@ -3,10 +3,10 @@
3
3
  word-break: normal !important;
4
4
  }
5
5
 
6
- /* For pieces of Markdown rendered in table cells. */
7
- .doc-contents td p {
8
- margin-top: 0 !important;
9
- margin-bottom: 0 !important;
6
+ /* No line break before first paragraph of descriptions. */
7
+ .doc-md-description,
8
+ .doc-md-description>p:first-child {
9
+ display: inline;
10
10
  }
11
11
 
12
12
  /* Avoid breaking code headings. */
@@ -18,10 +18,39 @@
18
18
  .doc-contents .field-name {
19
19
  min-width: 100px;
20
20
  }
21
- .doc-contents .field-name, .field-body {
21
+
22
+ /* Other curious-spacing fixes. */
23
+ .doc-contents .field-name,
24
+ .doc-contents .field-body {
22
25
  border: none !important;
23
26
  padding: 0 !important;
24
27
  }
28
+
29
+ .doc-contents p {
30
+ margin: 1em 0 1em;
31
+ }
32
+
25
33
  .doc-contents .field-list {
26
34
  margin: 0 !important;
27
35
  }
36
+
37
+ .doc-contents pre {
38
+ padding: 0 !important;
39
+ }
40
+
41
+ .doc-contents .wy-table-responsive {
42
+ margin-bottom: 0 !important;
43
+ }
44
+
45
+ .doc-contents td.code {
46
+ padding: 0 !important;
47
+ }
48
+
49
+ .doc-contents td.linenos {
50
+ padding: 0 8px !important;
51
+ }
52
+
53
+ .doc-children,
54
+ footer {
55
+ margin-top: 20px;
56
+ }
{mkdocstrings_python-1.1.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: mkdocstrings-python
3
- Version: 1.1.0
3
+ Version: 1.1.1
4
4
  Summary: A Python handler for mkdocstrings.
5
5
  Author-Email: Timothée Mazzucotelli <pawamoy@pm.me>
6
6
  License: ISC
{mkdocstrings_python-1.1.0.dist-info → mkdocstrings_python-1.1.1.dist-info}/RECORD RENAMED
@@ -7,15 +7,15 @@ mkdocstrings_handlers/python/templates/material/_base/children.html,sha256=NOf0L
7
7
  mkdocstrings_handlers/python/templates/material/_base/class.html,sha256=wtTLXZl8gvOicdfxOCQaFt_59bn754C1k2ILbE4XvlE,4078
8
8
  mkdocstrings_handlers/python/templates/material/_base/docstring.html,sha256=LZu_zGw1YyGHN1fq-loPN9eKyYwC3rDWMyQbh31hD20,1740
9
9
  mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html,sha256=wiD2FtMnGrFMZJDilURnNqzIu8bOR0zcMErUVUqbDPo,274
10
- mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html,sha256=NwDp0mIyCnI43glTtFUbU7g0F0QismxyGPa7KV0ia3c,2465
10
+ mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html,sha256=6b9_bsqTOP_Ye_SFhniGL6ikeDoVKRn7g7Mn7QVF9Po,2687
11
11
  mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html,sha256=TzN-q73kS2PlLmfkyQUr9YjBdrunKAuO6rYhxyfukyQ,400
12
- mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html,sha256=O9haz6hgC_s5i1TH5MCN7DVo47Mfz74NF3DvcKLlZoI,2475
13
- mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html,sha256=Zrwqa1lmktUyDSYWjXLsI21wNztcljx6khTH90LiS9g,3134
14
- mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html,sha256=HUn7I9ByR5SqIZSDd5_borKZKGVo5kyK8YbsnPYmY3Y,2132
15
- mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html,sha256=W4OmWPLChpAgQQoxdqZiYO9_3yYaalCIgxgd5rKoI6o,3111
16
- mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html,sha256=EXaLJoz2vtQWVPAtQt2kbIw8xP3Y001vv9SIZvbZaMk,3081
17
- mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html,sha256=8J7heEPD8IGNE-lr7mXAezB8RRWZ-YoUUdGnFl9FEpE,2115
18
- mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=43aDbTwzyGm4xyUf_p1T02MzsSHV_sNny2Se7KvPaqs,3051
12
+ mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html,sha256=CYO8l1n4OOP4mH5cDs9gZMDqF8-daQ9elTfTdU58IbY,2697
13
+ mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html,sha256=DAtSITqkaf0NCtfPTqWNnxLK5ne9mrDkSnIHYq83WSE,3356
14
+ mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html,sha256=TE0xmghh49v9BkbmyjeYiVGmXrJjI64dRIhprHfFLtM,2346
15
+ mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html,sha256=dY40JlN0e2uEVl0qtIiAbRX0sljz7_MWatYCdSNODdc,3333
16
+ mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html,sha256=lN8kdp7PlfITtiB_SefDo_qACw-wQISNpjWkFvmA8RY,3301
17
+ mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html,sha256=DIafhIfSwbMFQ9iiPpC1b0EOXTEBv3gBhZCW3gk9zpo,2329
18
+ mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html,sha256=2XAhsihe_74sTY5Cc_l_Pji5iYPo70mRxBIInq156jA,3273
19
19
  mkdocstrings_handlers/python/templates/material/_base/expression.html,sha256=up-Z_v7N7MAmj_UKfR8Xc9TJHnBggIxcQaMXmubzRt8,674
20
20
  mkdocstrings_handlers/python/templates/material/_base/function.html,sha256=_3-qihPbyZn9ijyUdJzfHSa1wA9NzCVzMx14Pq404EU,2436
21
21
  mkdocstrings_handlers/python/templates/material/_base/labels.html,sha256=Y85VylttZ7lYqtCjIjG3UjMaBNHWEiHEmfFMF6nyv6U,245
@@ -40,20 +40,17 @@ mkdocstrings_handlers/python/templates/material/function.html,sha256=SnLKA0qKWts
40
40
  mkdocstrings_handlers/python/templates/material/labels.html,sha256=-Jp8tj1BDi7a7f2GfLvyOWulzRBKpOe95JT6QwgfgCQ,34
41
41
  mkdocstrings_handlers/python/templates/material/module.html,sha256=GKdbkIxQoObcjxZP6PRLpLOYXMVFS4gSN-nxolEeDjw,34
42
42
  mkdocstrings_handlers/python/templates/material/signature.html,sha256=u9zdNsM5Lqh0ROOcThzsjHeHPJCMixy3XfzjypwyGLM,37
43
- mkdocstrings_handlers/python/templates/material/style.css,sha256=aYoiLDx0S8-eGS0sr1cscRlsCHkr6mBjsN4yZgHYPAU,703
44
- mkdocstrings_handlers/python/templates/mkdocs/exceptions.html,sha256=V4aZyaHggUpwOyOQtry6fGFqzTysJupiWCRSz3Bl5Og,224
45
- mkdocstrings_handlers/python/templates/mkdocs/keyword_args.html,sha256=RagEdkW3xwahCDAvYpDgzsxyRXj8h8V706l17DSoY5s,277
46
- mkdocstrings_handlers/python/templates/mkdocs/parameters.html,sha256=c7YSWlnKrrk2eNn3b6xDTIEKfHGVbvGhNHI6JjrlWTM,293
47
- mkdocstrings_handlers/python/templates/mkdocs/return.html,sha256=kJNhoMnMHJ1Gcr8i1sLLhvaWZ6MRzoJzh32rNcOIrww,200
48
- mkdocstrings_handlers/python/templates/mkdocs/style.css,sha256=WGJoK9h0PbiL5h_u1Nj5YoEgjPr3UiwCKAXU7vpLQ70,137
49
- mkdocstrings_handlers/python/templates/mkdocs/yield.html,sha256=8-1dmOywfphBOdoLBNwu7NdhnVxh7FgCp4klkILS3nU,196
50
- mkdocstrings_handlers/python/templates/readthedocs/exceptions.html,sha256=LN3Wje6V0yRMpyuqfNknZLnAvB9qf5sGXcduoy7tqy8,545
51
- mkdocstrings_handlers/python/templates/readthedocs/other_parameters.html,sha256=XrC5NWZfyBazyf0PYGzGPVPUOL_SPxz5XXaGlGbNw9k,601
52
- mkdocstrings_handlers/python/templates/readthedocs/parameters.html,sha256=c0pfsjfCwDAZCE48Jyp_2geXukJvf-0yvair2RBN4Yg,618
53
- mkdocstrings_handlers/python/templates/readthedocs/returns.html,sha256=1rvLz7n3xHkhc82mOCJdjgRpGGIFdJqhmiVpv9pdxBE,494
54
- mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=FNcAj6sgr1H8cg9MCkqlOMoYeM2EWExIRVRCmilL9YY,600
55
- mkdocstrings_handlers/python/templates/readthedocs/yields.html,sha256=QLl6geeYfOHJ3xwmuRl-rAScei0DtIxFmlSgVO53Hhc,490
56
- mkdocstrings_python-1.1.0.dist-info/METADATA,sha256=aLxaWwtWx69109-NNM1s2QMyr7TnhWnC0fuZjWUub4c,5747
57
- mkdocstrings_python-1.1.0.dist-info/WHEEL,sha256=m6kf1fJuo48rT4uxh0SeA_FsGq51BpCh_8VNBKVwYQA,90
58
- mkdocstrings_python-1.1.0.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
59
- mkdocstrings_python-1.1.0.dist-info/RECORD,,
43
+ mkdocstrings_handlers/python/templates/material/style.css,sha256=d0A4LjU-pNbb23hyyP8I32B2fFjlZ1ngU2-ukzmwubk,623
44
+ mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html,sha256=setEEw-4Ycb5d6FXxlMXuGIpkEqOwn78JgXX4pF8FBw,928
45
+ mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html,sha256=mX0EE_jil-nvhMpmZeKPAtlV2yqWpezvvLoRZs1SaUA,934
46
+ mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html,sha256=s4jwdD8fzWBaMRXDgFMQoB0tmP7gtzugksQODCNP6rY,928
47
+ mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html,sha256=zCexVPRpZQECSErVQcZPlHp9BQv_0p4LmJi1tFPC3h8,868
48
+ mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html,sha256=Zf4kYW_TBeWcreb6wvb1cOP_cm2_uUpSW3m968VqncA,1058
49
+ mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html,sha256=g54wjwNw_nPG_k9HpEzyC5eRuh-U3vZeZ2gdg5CIpX0,1007
50
+ mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html,sha256=HDKm9LUkW4uYk0YZufzHHz241IlBM897_2KQveIuSQM,863
51
+ mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html,sha256=Wzoi81LqoPZEXU4OWyRgH4LMZIZcnfbrTJKPf3LqHYM,1040
52
+ mkdocstrings_handlers/python/templates/readthedocs/style.css,sha256=Ds8vF1rSxc2B0c4P10osx4cqXHWMntcSCxmRfX-nfzw,971
53
+ mkdocstrings_python-1.1.1.dist-info/METADATA,sha256=m9y6759JzpWIqlwNcfhtfm96zCcW13G7_ouPXeT49gQ,5747
54
+ mkdocstrings_python-1.1.1.dist-info/WHEEL,sha256=m6kf1fJuo48rT4uxh0SeA_FsGq51BpCh_8VNBKVwYQA,90
55
+ mkdocstrings_python-1.1.1.dist-info/licenses/LICENSE,sha256=JGb4pdPEM8TTjjhr-uNCO7oXkiVrwG5Pz0JamcjNF_s,754
56
+ mkdocstrings_python-1.1.1.dist-info/RECORD,,
mkdocstrings_handlers/python/templates/mkdocs/exceptions.html DELETED
@@ -1,7 +0,0 @@
1
- {{ log.debug() }}
2
- <dl>
3
- <dt>Exceptions:</dt>
4
- {% for exception in exceptions %}
5
- <dd>{{ ("`" + exception.annotation + "`: " + exception.description)|convert_markdown(heading_level, html_id) }}</dd>
6
- {% endfor %}
7
- </dl>
mkdocstrings_handlers/python/templates/mkdocs/keyword_args.html DELETED
@@ -1,7 +0,0 @@
1
- {{ log.debug() }}
2
- <dl>
3
- <dt>Keyword arguments:</dt>
4
- {% for kwarg in kwargs %}
5
- <dd>{{ ("**" + kwarg.name + ":** " + ("`" + kwarg.annotation + "` – " if kwarg.annotation else "") + kwarg.description)|convert_markdown(heading_level, html_id) }}</dd>
6
- {% endfor %}
7
- </dl>
mkdocstrings_handlers/python/templates/mkdocs/parameters.html DELETED
@@ -1,7 +0,0 @@
1
- {{ log.debug() }}
2
- <dl>
3
- <dt>Arguments:</dt>
4
- {% for parameter in parameters %}
5
- <dd>{{ ("**" + parameter.name + ":** " + ("`" + parameter.annotation + "` – " if parameter.annotation else "") + parameter.description)|convert_markdown(heading_level, html_id) }}</dd>
6
- {% endfor %}
7
- </dl>
mkdocstrings_handlers/python/templates/mkdocs/return.html DELETED
@@ -1,5 +0,0 @@
1
- {{ log.debug() }}
2
- <dl>
3
- <dt>Returns:</dt>
4
- <dd>{{ (("`" + return.annotation + "` – " if return.annotation else "") + return.description)|convert_markdown(heading_level, html_id) }}</dd>
5
- </dl>
mkdocstrings_handlers/python/templates/mkdocs/style.css DELETED
@@ -1,11 +0,0 @@
1
- .doc-contents {
2
- padding-left: 20px;
3
- }
4
-
5
- .doc-contents dd>p {
6
- margin-bottom: 0.5rem;
7
- }
8
-
9
- .doc-contents dl+dl {
10
- margin-top: -0.5rem;
11
- }
mkdocstrings_handlers/python/templates/mkdocs/yield.html DELETED
@@ -1,5 +0,0 @@
1
- {{ log.debug() }}
2
- <dl>
3
- <dt>Yields:</dt>
4
- <dd>{{ (("`" + yield.annotation + "` – " if yield.annotation else "") + yield.description)|convert_markdown(heading_level, html_id) }}</dd>
5
- </dl>
mkdocstrings_handlers/python/templates/readthedocs/exceptions.html DELETED
@@ -1,19 +0,0 @@
1
- {{ log.debug() }}
2
- <table class="field-list">
3
- <colgroup>
4
- <col class="field-name" />
5
- <col class="field-body" />
6
- </colgroup>
7
- <tbody valign="top">
8
- <tr class="field">
9
- <th class="field-name">Exceptions:</th>
10
- <td class="field-body">
11
- <ul class="first simple">
12
- {% for exception in exceptions %}
13
- <li>{{ ("`" + exception.annotation + "` – " + exception.description)|convert_markdown(heading_level, html_id) }}</li>
14
- {% endfor %}
15
- </ul>
16
- </td>
17
- </tr>
18
- </tbody>
19
- </table>
mkdocstrings_handlers/python/templates/readthedocs/other_parameters.html DELETED
@@ -1,19 +0,0 @@
1
- {{ log.debug() }}
2
- <table class="field-list">
3
- <colgroup>
4
- <col class="field-name" />
5
- <col class="field-body" />
6
- </colgroup>
7
- <tbody valign="top">
8
- <tr class="field">
9
- <th class="field-name">Keyword arguments:</th>
10
- <td class="field-body">
11
- <ul class="first simple">
12
- {% for kwarg in kwargs %}
13
- <li>{{ ("**" + kwarg.name + "**" + (" (`" + kwarg.annotation + "`)" if kwarg.annotation else "") + " – " + kwarg.description)|convert_markdown(heading_level, html_id) }}</li>
14
- {% endfor %}
15
- </ul>
16
- </td>
17
- </tr>
18
- </tbody>
19
- </table>
mkdocstrings_handlers/python/templates/readthedocs/parameters.html DELETED
@@ -1,19 +0,0 @@
1
- {{ log.debug() }}
2
- <table class="field-list">
3
- <colgroup>
4
- <col class="field-name" />
5
- <col class="field-body" />
6
- </colgroup>
7
- <tbody valign="top">
8
- <tr class="field">
9
- <th class="field-name">Parameters:</th>
10
- <td class="field-body">
11
- <ul class="first simple">
12
- {% for parameter in parameters %}
13
- <li>{{ ("**" + parameter.name + "**" + (" (`" + parameter.annotation + "`)" if parameter.annotation else "") + " – " + parameter.description)|convert_markdown(heading_level, html_id) }}</li>
14
- {% endfor %}
15
- </ul>
16
- </td>
17
- </tr>
18
- </tbody>
19
- </table>
mkdocstrings_handlers/python/templates/readthedocs/returns.html DELETED
@@ -1,17 +0,0 @@
1
- {{ log.debug() }}
2
- <table class="field-list">
3
- <colgroup>
4
- <col class="field-name" />
5
- <col class="field-body" />
6
- </colgroup>
7
- <tbody valign="top">
8
- <tr class="field">
9
- <th class="field-name">Returns:</th>
10
- <td class="field-body">
11
- <ul class="first simple">
12
- <li>{{ ((("`" + return.annotation + "` – ") if return.annotation else "") + return.description)|convert_markdown(heading_level, html_id) }}</li>
13
- </ul>
14
- </td>
15
- </tr>
16
- </tbody>
17
- </table>
mkdocstrings_handlers/python/templates/readthedocs/yields.html DELETED
@@ -1,17 +0,0 @@
1
- {{ log.debug() }}
2
- <table class="field-list">
3
- <colgroup>
4
- <col class="field-name" />
5
- <col class="field-body" />
6
- </colgroup>
7
- <tbody valign="top">
8
- <tr class="field">
9
- <th class="field-name">Yields:</th>
10
- <td class="field-body">
11
- <ul class="first simple">
12
- <li>{{ ((("`" + yield.annotation + "` – ") if yield.annotation else "") + yield.description)|convert_markdown(heading_level, html_id) }}</li>
13
- </ul>
14
- </td>
15
- </tr>
16
- </tbody>
17
- </table>