1.9 KiB
{% if not obj.display %} :orphan:
{% endif %} :mod:`{{ obj.name }}` ======={{ "=" * obj.name|length }}
System Message: ERROR/3 (<stdin>, line 4); backlink
Unknown interpreted text role "mod".System Message: ERROR/3 (<stdin>, line 8)
Unknown directive type "py:module".
.. py:module:: {{ obj.name }}
{% if obj.docstring %} .. autoapi-nested-parse:
{{ obj.docstring|prepare_docstring|indent(3) }}
{% endif %}
{% block subpackages %} {% set visible_subpackages = obj.subpackages|selectattr("display")|list %} {% if visible_subpackages %} Subpackages ----------- .. toctree:
System Message: ERROR/3 (<stdin>, line 23)
Unexpected indentation.:titlesonly: :maxdepth: 3
- {% for subpackage in visible_subpackages %}
- {{ subpackage.short_name }}/index.rst
System Message: WARNING/2 (<stdin>, line 28)
Definition list ends without a blank line; unexpected unindent.{% endfor %}
{% endif %} {% endblock %} {% block submodules %} {% set visible_submodules = obj.submodules|selectattr("display")|list %} {% if visible_submodules %} Submodules ----------
The {{ obj.name }} module contains the following submodules
System Message: ERROR/3 (<stdin>, line 41)
Unknown directive type "toctree".
.. toctree:: :titlesonly: :maxdepth: 1
- {% for submodule in visible_submodules %}
- {{ submodule.short_name }}/index.rst
System Message: WARNING/2 (<stdin>, line 47)
Definition list ends without a blank line; unexpected unindent.{% endfor %}
{% endif %} {% endblock %} {% block content %} {% set visible_children = obj.children|selectattr("display")|list %} {% 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 %} {% if include_summaries and (visible_classes or visible_functions) %} {% block classes %} {% if visible_classes %} Classes ~~~~~~~
System Message: ERROR/3 (<stdin>, line 66)
Unknown directive type "autoapisummary".
.. autoapisummary::
- {% for klass in visible_classes %}
- {{ klass.id }}
System Message: WARNING/2 (<stdin>, line 70)
Definition list ends without a blank line; unexpected unindent.{% endfor %}
{% endif %} {% endblock %}
{% block functions %} {% if visible_functions %} Functions ~~~~~~~~~
System Message: ERROR/3 (<stdin>, line 81)
Unknown directive type "autoapisummary".
.. autoapisummary::
- {% for function in visible_functions %}
- {{ function.id }}
System Message: WARNING/2 (<stdin>, line 85)
Definition list ends without a blank line; unexpected unindent.{% endfor %}
{% endif %} {% endblock %} {% endif %} {% for obj_item in visible_children %} {% if obj.all is none or obj_item.short_name in obj.all %} {{ obj_item.rendered|indent(0) }} {% endif %} {% endfor %} {% endif %} {% endblock %}