package.rst 1.64 KB
Newer Older
1
2
3
4
5
6
7
{% if name %}
{{ name }}
{% for item in range(8 + name|length) -%}={%- endfor %}
{% else %}
{{ fullname }}
{% for item in range(8 + fullname|length) -%}={%- endfor %}
{% endif %}
8
({{ fullname }} package)
9
10
11
12
13
14
15
16
17
18

.. automodule:: {{ fullname }}
    {% if members -%}
    :members: {{ members|join(", ") }}
    :undoc-members:
    :show-inheritance:
    {%- endif %}


    {% if submodules %}
19
20
    Submodules
    ----------
21
22
23
24
25
26
27
28
29
30
31

    .. toctree::
        :maxdepth: 1
        {% for item in submodules %}
        {{ fullname }}.{{ item }}
        {%- endfor %}
    {%- endif -%}

    {% if subpackages %}


32
33
    Subpackages
    -----------
34
35
36
37
38
39
40
41
42
43

    .. toctree::
        :maxdepth: 1
        {% for item in subpackages %}
        {{ fullname }}.{{ item }}
        {%- endfor %}


    {%- endif %}

44
    {% if members %}
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
    Summary
    -------

    {%- if exceptions %}

    Exceptions:

    .. autosummary::
        :nosignatures:
        {% for item in exceptions %}
        {{ item }}
        {%- endfor %}
    {%- endif %}

    {%- if classes %}

    Classes:

    .. autosummary::
        :nosignatures:
        {% for item in classes %}
        {{ item }}
        {%- endfor %}
    {%- endif %}

    {%- if functions %}

    Functions:

    .. autosummary::
        :nosignatures:
        {% for item in functions %}
        {{ item }}
        {%- endfor %}
    {%- endif %}

    {%- endif %}

    {%- if data %}

    Data:

    .. autosummary::
        :nosignatures:
        {% for item in data %}
        {{ item }}
        {%- endfor %}
    {%- endif %}

{% if all_refs %}
    ``__all__``: {{ all_refs|join(", ") }}
{%- endif %}


{% if members %}
    Reference
    ---------

{%- endif %}