| 1 |
{% if not obj.display %} |
| 2 |
:orphan: |
| 3 |
{% endif %} |
| 4 |
|
| 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 |
{% endif %} |
| 15 |
|
| 16 |
{% block subpackages %} |
| 17 |
{% set visible_subpackages = obj.subpackages|selectattr("display")|list %} |
| 18 |
{% if visible_subpackages %} |
| 19 |
Subpackages |
| 20 |
----------- |
| 21 |
.. toctree:: |
| 22 |
:titlesonly: |
| 23 |
:maxdepth: 2 |
| 24 |
|
| 25 |
{% for subpackage in visible_subpackages %} |
| 26 |
{{ subpackage.short_name }} <{{ subpackage.short_name }}/index.rst> |
| 27 |
{% endfor %} |
| 28 |
{% endif %} |
| 29 |
{% endblock %} |
| 30 |
|
| 31 |
{% block submodules %} |
| 32 |
{% set visible_submodules = obj.submodules|selectattr("display")|list %} |
| 33 |
{% if visible_submodules %} |
| 34 |
Submodules |
| 35 |
---------- |
| 36 |
.. toctree:: |
| 37 |
:titlesonly: |
| 38 |
:maxdepth: 1 |
| 39 |
|
| 40 |
{% for submodule in visible_submodules %} |
| 41 |
{{ submodule.short_name }} <{{ submodule.short_name }}/index.rst> |
| 42 |
{% endfor %} |
| 43 |
{% endif %} |
| 44 |
{% endblock %} |
| 45 |
|
| 46 |
{% if obj.all is not none %} |
| 47 |
{% set visible_children = obj.children|selectattr("short_name", "in", obj.all)|list %} |
| 48 |
{% elif obj.type is equalto("package") %} |
| 49 |
{% set visible_children = obj.children|selectattr("display")|list %} |
| 50 |
{% else %} |
| 51 |
{% set visible_children = obj.children|selectattr("display")|rejectattr("imported")|list %} |
| 52 |
{% endif %} |
| 53 |
|
| 54 |
{% if visible_children %} {# if visible_children #} |
| 55 |
|
| 56 |
{% set visible_classes = visible_children|selectattr("type", "equalto", "class")|list %} |
| 57 |
{% set visible_functions = visible_children|selectattr("type", "equalto", "function")|list %} |
| 58 |
{% set visible_attributes = visible_children|selectattr("type", "equalto", "data")|list %} |
| 59 |
{% if "show-module-summary" in autoapi_options |
| 60 |
and (visible_classes or visible_functions or visible_attributes) %} |
| 61 |
{# if show-summaries #} |
| 62 |
{# === CLASSES SUMMARY === #} |
| 63 |
{% block classes scoped %} |
| 64 |
{% if visible_classes %} |
| 65 |
Classes |
| 66 |
------- |
| 67 |
|
| 68 |
.. autosummary:: |
| 69 |
|
| 70 |
{% for klass in visible_classes %} |
| 71 |
~{{ klass.id }} |
| 72 |
{% endfor %} |
| 73 |
{% endif %} |
| 74 |
{% endblock %} |
| 75 |
|
| 76 |
{# === FUNCTIONS SUMMARY === #} |
| 77 |
{% block functions scoped %} |
| 78 |
{% if visible_functions %} |
| 79 |
Functions |
| 80 |
--------- |
| 81 |
|
| 82 |
.. autosummary:: |
| 83 |
|
| 84 |
{% for function in visible_functions %} |
| 85 |
~{{ function.id }} |
| 86 |
{% endfor %} |
| 87 |
{% endif %} |
| 88 |
{% endblock %} |
| 89 |
|
| 90 |
{# === ATTRIBUTES SUMMARY === #} |
| 91 |
{% block attributes scoped %} |
| 92 |
{% if visible_attributes %} |
| 93 |
Attributes |
| 94 |
---------- |
| 95 |
|
| 96 |
.. autoapisummary:: |
| 97 |
|
| 98 |
{% for data in visible_attributes %} |
| 99 |
{{ data.id }} |
| 100 |
{% endfor %} |
| 101 |
{% endif %} |
| 102 |
{% endblock %} |
| 103 |
|
| 104 |
{% endif %} {# endif show-summaries #} |
| 105 |
|
| 106 |
{# === CONTENTS === #} |
| 107 |
{% block contents scoped %} |
| 108 |
Contents |
| 109 |
-------- |
| 110 |
{% for obj_item in visible_children %} |
| 111 |
{{ obj_item.rendered|indent(0) }} |
| 112 |
{% endfor %} |
| 113 |
{% endblock %} |
| 114 |
|
| 115 |
{% endif %} {# endif visible-children #} |