1  {% if not obj.display %}
 2  :orphan:
 3  
 4  {% endif %}
 5  :mod:`{{ obj.name }}`
 6  ======={{ "=" * obj.name|length }}
 7  
 8  .. py:module:: {{ obj.name }}
 9  
10  {% if obj.docstring %}
11  .. autoapi-nested-parse::
12  
13     {{ obj.docstring|prepare_docstring|indent(3) }}
14  
15  {% endif %}
16  
17  {% block subpackages %}
18  {% set visible_subpackages = obj.subpackages|selectattr("display")|list %}
19  {% if visible_subpackages %}
20  Subpackages
21  -----------
22  .. toctree::
23     :maxdepth: 1
24  
25  {% for subpackage in visible_subpackages %}
26     {{ subpackage.short_name }}/index.rst
27  {% endfor %}
28  
29  
30  {% endif %}
31  {% endblock %}
32  {% block submodules %}
33  {% set visible_submodules = obj.submodules|selectattr("display")|list %}
34  {% if visible_submodules %}
35  Submodules
36  ----------
37  .. toctree::
38     :maxdepth: 1
39  
40  {% for submodule in visible_submodules %}
41     {{ submodule.short_name }}/index.rst
42  {% endfor %}
43  
44  
45  {% endif %}
46  {% endblock %}
47  {% block content %}
48  {% if obj.all is not none %}
49  {% set visible_children = obj.children|selectattr("short_name", "in", obj.all)|list %}
50  {% elif obj.type is equalto("package") %}
51  {% set visible_children = obj.children|selectattr("display")|list %}
52  {% else %}
53  {% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %}
54  {% endif %}
55  {% if visible_children %}
56  {{ obj.type|title }} Contents
57  {{ "-" * obj.type|length }}---------
58  
59  
60  {% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %}
61  {% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %}
62  
63  {% if "show-module-summary" in autoapi_options and (visible_classes or visible_functions) %}
64  
65  {% block classes scoped %}
66  {% if visible_classes %}
67  Classes
68  ~~~~~~~
69  
70  .. autoapisummary::
71  
72  {% for klass in visible_classes %}
73     {{ klass.id }}
74  {% endfor %}
75  
76  
77  {% endif %}
78  {% endblock %}
79  
80  {% block functions scoped %}
81  {% if visible_functions %}
82  Functions
83  ~~~~~~~~~
84  
85  .. autoapisummary::
86  
87  {% for function in visible_functions %}
88     {{ function.id }}
89  {% endfor %}
90  
91  
92  {% endif %}
93  {% endblock %}
94  {% endif %}
95  {% for obj_item in visible_children %}
96  {{ obj_item.rendered|indent(0) }}
97  {% endfor %}
98  {% endif %}
99  {% endblock %}