mudata_py/docs/_templates/autosummary/class.rst at ee917f08d202d6ffdd82254f83f0bde3a359ff20 · ilia-kats/mudata_py · 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
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
{{ fullname | escape | underline}}

.. currentmodule:: {{ module }}

.. add toctree option to make autodoc generate the pages

.. autoclass:: {{ objname }}

{% block attributes %}
{% if attributes %}
    Attributes table
    ~~~~~~~~~~~~~~~~

    .. autosummary::
    {% for item in attributes %}
        ~{{ name }}.{{ item }}
    {%- endfor %}
    {% endif %}
    {% endblock %}

{% block methods %}
{% if methods %}
    Methods table
    ~~~~~~~~~~~~~

    .. autosummary::
    {% for item in methods %}
        {%- if item != '__init__' %}
        ~{{ name }}.{{ item }}
        {%- endif -%}
    {%- endfor %}
    {% endif %}
    {% endblock %}

{% block attributes_documentation %}
{% if attributes %}
    Attributes
    ~~~~~~~~~~

{% for item in attributes %}

    .. autoattribute:: {{ [objname, item] | join(".") }}
{%- endfor %}

{% endif %}
{% endblock %}

{% block methods_documentation %}
{% if methods %}
    Methods
    ~~~~~~~

{% for item in methods %}
{%- if item != '__init__' %}

    .. automethod:: {{ [objname, item] | join(".") }}
{%- endif -%}
{%- endfor %}

{% endif %}
{% endblock %}