File size: 2,523 Bytes
861dfcc
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
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
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
104
105
106
107
108
109
110
111
112
113
{% if not obj.display %}

:orphan:



{% endif %}

:py:mod:`{{ obj.name if obj.name.count(".") <= 1 else obj.short_name }}`

=========={{ "=" * (obj.name|length if obj.name.count(".") <= 1 else obj.short_name|length) }}



.. py:module:: {{ obj.name }}



{% if obj.docstring %}

.. autoapi-nested-parse::



   {{ obj.docstring|indent(3) }}



{% endif %}



{% block subpackages %}

{% set visible_subpackages = obj.subpackages|selectattr("display")|list %}

{% if visible_subpackages %}

Subpackages

-----------

.. toctree::

   :titlesonly:

   :maxdepth: 3



{% for subpackage in visible_subpackages %}

   {{ subpackage.short_name }}/index.rst

{% endfor %}





{% endif %}

{% endblock %}

{% block submodules %}

{% set visible_submodules = obj.submodules|selectattr("display")|list %}

{% if visible_submodules %}

Submodules

----------

.. toctree::

   :titlesonly:

   :maxdepth: 1



{% for submodule in visible_submodules %}

   {{ submodule.short_name }}/index.rst

{% endfor %}





{% endif %}

{% endblock %}

{% block content %}

{% if obj.type is equalto("package") %}

{% set visible_children = obj.children|selectattr("display")|list %}

{% else %}

{% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %}

{% endif %}

{% if visible_children %}

{{ obj.type|title }} Contents

{{ "-" * obj.type|length }}---------



{% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %}

{% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %}

{% set visible_attributes = visible_children|selectattr("type", "equalto", "data")|list %}

{% if "show-module-summary" in autoapi_options and (visible_classes or visible_functions) %}

{% block classes scoped %}

{% if visible_classes %}

Classes

~~~~~~~



.. autoapisummary::



{% for klass in visible_classes %}

   {{ klass.id }}

{% endfor %}





{% endif %}

{% endblock %}



{% block functions scoped %}

{% if visible_functions %}

Functions

~~~~~~~~~



.. autoapisummary::



{% for function in visible_functions %}

   {{ function.id }}

{% endfor %}





{% endif %}

{% endblock %}



{% block attributes scoped %}

{% if visible_attributes %}

Attributes

~~~~~~~~~~



.. autoapisummary::



{% for attribute in visible_attributes %}

   {{ attribute.id }}

{% endfor %}





{% endif %}

{% endblock %}

{% endif %}

{% for obj_item in visible_children %}

{{ obj_item.render()|indent(0) }}

{% endfor %}

{% endif %}

{% endblock %}