mkdocstrings-python 1.1.0__tar.gz → 1.1.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 (73) hide show
  1. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/PKG-INFO +1 -1
  2. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/pyproject.toml +1 -1
  3. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/attributes.html +12 -3
  4. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/other_parameters.html +12 -3
  5. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/parameters.html +12 -3
  6. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/raises.html +11 -3
  7. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/receives.html +12 -3
  8. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/returns.html +12 -3
  9. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/warns.html +11 -3
  10. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/yields.html +12 -3
  11. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/style.css +6 -10
  12. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/attributes.html +30 -0
  13. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/other_parameters.html +30 -0
  14. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/parameters.html +30 -0
  15. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/raises.html +29 -0
  16. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/receives.html +32 -0
  17. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/returns.html +32 -0
  18. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/warns.html +29 -0
  19. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/docstring/yields.html +32 -0
  20. mkdocstrings_python-1.1.1/src/mkdocstrings_handlers/python/templates/readthedocs/style.css +56 -0
  21. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/mkdocs/exceptions.html +0 -7
  22. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/mkdocs/keyword_args.html +0 -7
  23. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/mkdocs/parameters.html +0 -7
  24. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/mkdocs/return.html +0 -5
  25. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/mkdocs/style.css +0 -11
  26. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/mkdocs/yield.html +0 -5
  27. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/readthedocs/exceptions.html +0 -19
  28. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/readthedocs/other_parameters.html +0 -19
  29. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/readthedocs/parameters.html +0 -19
  30. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/readthedocs/returns.html +0 -17
  31. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/readthedocs/style.css +0 -27
  32. mkdocstrings_python-1.1.0/src/mkdocstrings_handlers/python/templates/readthedocs/yields.html +0 -17
  33. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/LICENSE +0 -0
  34. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/README.md +0 -0
  35. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/py.typed +0 -0
  36. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/__init__.py +0 -0
  37. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/handler.py +0 -0
  38. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/rendering.py +0 -0
  39. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/attribute.html +0 -0
  40. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/children.html +0 -0
  41. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/class.html +0 -0
  42. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/admonition.html +0 -0
  43. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring/examples.html +0 -0
  44. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/docstring.html +0 -0
  45. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/expression.html +0 -0
  46. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/function.html +0 -0
  47. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/labels.html +0 -0
  48. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/module.html +0 -0
  49. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/_base/signature.html +0 -0
  50. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/attribute.html +0 -0
  51. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/children.html +0 -0
  52. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/class.html +0 -0
  53. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/admonition.html +0 -0
  54. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/attributes.html +0 -0
  55. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/examples.html +0 -0
  56. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/other_parameters.html +0 -0
  57. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/parameters.html +0 -0
  58. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/raises.html +0 -0
  59. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/receives.html +0 -0
  60. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/returns.html +0 -0
  61. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/warns.html +0 -0
  62. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring/yields.html +0 -0
  63. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/docstring.html +0 -0
  64. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/expression.html +0 -0
  65. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/function.html +0 -0
  66. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/labels.html +0 -0
  67. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/module.html +0 -0
  68. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/src/mkdocstrings_handlers/python/templates/material/signature.html +0 -0
  69. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/tests/__init__.py +0 -0
  70. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/tests/conftest.py +0 -0
  71. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/tests/test_handler.py +0 -0
  72. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.1}/tests/test_rendering.py +0 -0
  73. {mkdocstrings_python-1.1.0 → mkdocstrings_python-1.1.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.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
@@ -35,7 +35,7 @@ dependencies = [
35
35
  "mkdocstrings>=0.20",
36
36
  "griffe>=0.24",
37
37
  ]
38
- version = "1.1.0"
38
+ version = "1.1.1"
39
39
 
40
40
  [project.license]
41
41
  text = "ISC"
@@ -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">
@@ -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">
@@ -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">
@@ -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 %}
@@ -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">
@@ -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">
@@ -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 %}
@@ -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">
@@ -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
+ }
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -0,0 +1,56 @@
1
+ /* Avoid breaking parameters name, etc. in table cells. */
2
+ .doc-contents td code {
3
+ word-break: normal !important;
4
+ }
5
+
6
+ /* No line break before first paragraph of descriptions. */
7
+ .doc-md-description,
8
+ .doc-md-description>p:first-child {
9
+ display: inline;
10
+ }
11
+
12
+ /* Avoid breaking code headings. */
13
+ .doc-heading code {
14
+ white-space: normal;
15
+ }
16
+
17
+ /* Improve rendering of parameters, returns and exceptions. */
18
+ .doc-contents .field-name {
19
+ min-width: 100px;
20
+ }
21
+
22
+ /* Other curious-spacing fixes. */
23
+ .doc-contents .field-name,
24
+ .doc-contents .field-body {
25
+ border: none !important;
26
+ padding: 0 !important;
27
+ }
28
+
29
+ .doc-contents p {
30
+ margin: 1em 0 1em;
31
+ }
32
+
33
+ .doc-contents .field-list {
34
+ margin: 0 !important;
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
+ }
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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
- }
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -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>
@@ -1,27 +0,0 @@
1
- /* Avoid breaking parameters name, etc. in table cells. */
2
- .doc-contents td code {
3
- word-break: normal !important;
4
- }
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;
10
- }
11
-
12
- /* Avoid breaking code headings. */
13
- .doc-heading code {
14
- white-space: normal;
15
- }
16
-
17
- /* Improve rendering of parameters, returns and exceptions. */
18
- .doc-contents .field-name {
19
- min-width: 100px;
20
- }
21
- .doc-contents .field-name, .field-body {
22
- border: none !important;
23
- padding: 0 !important;
24
- }
25
- .doc-contents .field-list {
26
- margin: 0 !important;
27
- }
@@ -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>