{% if not obj.display %} :orphan:
{% endif %}
{{ obj.short_name }}
=========={{ "=" * obj.short_name|length }}
{% if obj.docstring %} .. autoapi-nested-parse:
{{ obj.docstring|indent(3) }}
{% endif %}
{% block subpackages %} {% set visible_subpackages = obj.subpackages|selectattr("display")|list %} {% set visible_submodules = obj.submodules|selectattr("display")|list %} {% if visible_subpackages or visible_submodules %} .. toctree:
:hidden:
:titlesonly:
:maxdepth: 3
- {% for subpackage in (visible_subpackages + visible_submodules)|sort %}
{{ subpackage.short_name }}/index.rst
{% endfor %}
{% endif %} {% endblock %} {% block content %} {% if obj.all is not none %} {% set visible_children = obj.children|selectattr("short_name", "in", obj.all)|list %} {% elif 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 %} {% 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 -------
- {% for klass in visible_classes %}
{{ klass.id }}
{% endfor %}
{% endif %} {% endblock %}
{% block functions scoped %} {% if visible_functions %} Functions ---------
- {% for function in visible_functions %}
{{ function.id }}
{% endfor %}
{% endif %} {% endblock %}
{% block attributes scoped %} {% if visible_attributes %} Attributes ----------
- {% 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 %}