autoDocstring/src/docstring/templates/sphinx.mustache at 973fb880a86f4839fc3acf164009cbf2c39c9bcc · NilsJPWerner/autoDocstring · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
{{! Sphinx Docstring Template }}
{{summaryPlaceholder}}

{{extendedSummaryPlaceholder}}

{{#classesExist}}
Classes
-------
{{#classes}}
{{name}}
{{/classes}}
{{/classesExist}}

{{#methodsExist}}
Methods
-------
{{#methods}}
{{name}}
{{/methods}}
{{/methodsExist}}

{{#args}}
:param {{var}}: {{descriptionPlaceholder}}
:type {{var}}: {{typePlaceholder}}
{{/args}}
{{#kwargs}}
:param {{var}}: {{descriptionPlaceholder}}, defaults to {{&default}}
:type {{var}}: {{typePlaceholder}}, optional
{{/kwargs}}
{{#exceptions}}
:raises {{type}}: {{descriptionPlaceholder}}
{{/exceptions}}
{{#returns}}
:return: {{descriptionPlaceholder}}
:rtype: {{typePlaceholder}}
{{/returns}}
{{#yields}}
:yield: {{descriptionPlaceholder}}
:rtype: {{typePlaceholder}}
{{/yields}}