|
a |
|
b/docs/_templates/autosummary/class.rst |
|
|
1 |
{{ fullname | escape | underline}} |
|
|
2 |
|
|
|
3 |
.. currentmodule:: {{ module }} |
|
|
4 |
|
|
|
5 |
.. add toctree option to make autodoc generate the pages |
|
|
6 |
|
|
|
7 |
.. autoclass:: {{ objname }} |
|
|
8 |
|
|
|
9 |
{% block attributes %} |
|
|
10 |
{% if attributes %} |
|
|
11 |
Attributes table |
|
|
12 |
~~~~~~~~~~~~~~~~~~ |
|
|
13 |
|
|
|
14 |
.. autosummary:: |
|
|
15 |
{% for item in attributes %} |
|
|
16 |
~{{ fullname }}.{{ item }} |
|
|
17 |
{%- endfor %} |
|
|
18 |
{% endif %} |
|
|
19 |
{% endblock %} |
|
|
20 |
|
|
|
21 |
{% block methods %} |
|
|
22 |
{% if methods %} |
|
|
23 |
Methods table |
|
|
24 |
~~~~~~~~~~~~~ |
|
|
25 |
|
|
|
26 |
.. autosummary:: |
|
|
27 |
{% for item in methods %} |
|
|
28 |
{%- if item != '__init__' %} |
|
|
29 |
~{{ fullname }}.{{ item }} |
|
|
30 |
{%- endif -%} |
|
|
31 |
{%- endfor %} |
|
|
32 |
{% endif %} |
|
|
33 |
{% endblock %} |
|
|
34 |
|
|
|
35 |
{% block attributes_documentation %} |
|
|
36 |
{% if attributes %} |
|
|
37 |
Attributes |
|
|
38 |
~~~~~~~~~~~ |
|
|
39 |
|
|
|
40 |
{% for item in attributes %} |
|
|
41 |
|
|
|
42 |
.. autoattribute:: {{ [objname, item] | join(".") }} |
|
|
43 |
{%- endfor %} |
|
|
44 |
|
|
|
45 |
{% endif %} |
|
|
46 |
{% endblock %} |
|
|
47 |
|
|
|
48 |
{% block methods_documentation %} |
|
|
49 |
{% if methods %} |
|
|
50 |
Methods |
|
|
51 |
~~~~~~~ |
|
|
52 |
|
|
|
53 |
{% for item in methods %} |
|
|
54 |
{%- if item != '__init__' %} |
|
|
55 |
|
|
|
56 |
.. automethod:: {{ [objname, item] | join(".") }} |
|
|
57 |
{%- endif -%} |
|
|
58 |
{%- endfor %} |
|
|
59 |
|
|
|
60 |
{% endif %} |
|
|
61 |
{% endblock %} |