{{ package.name }}

Python Package Reference Documentation
{% if package_docstring %}
{{ package_docstring | safe }}
{% endif %} {% if package_link_path %}

Package-level classes and functions

{% endif %}

{{ total_modules }} module{% if total_modules != 1 %}s{% endif %}, {{ total_classes }} class{% if total_classes != 1 %}es{% endif %}, {{ total_functions }} function{% if total_functions != 1 %}s{% endif %} in this build.

Modules

{% for group in nav_groups %} {% if group.name %} {% set class_count = group.classes | length %} {% set func_count = group.functions | length %} {% set symbol_count = class_count + func_count %} {% set submodule_count = group.modules | length %} {% set contents_count = symbol_count + submodule_count %}

{% if group.link_path %}{{ group.name }}{% else %}{{ group.name }}{% endif %}

{% if group.docstring %} {{ group.docstring | striptags | truncate(length=140) }} {% elif submodule_count > 0 %} {{ submodule_count }} submodule{% if submodule_count != 1 %}s{% endif %}. {% else %} No description provided. {% endif %}

{% if contents_count > 0 %}
Show contents ({{ contents_count }}) {% if symbol_count > 0 %}
Symbols
{% endif %} {% if submodule_count > 0 %}
Submodules
    {% for mod in group.modules %} {% set mod_class_count = mod.classes | length %} {% set mod_func_count = mod.functions | length %} {% set mod_symbol_count = mod_class_count + mod_func_count %}
  • {{ mod.name }} {% if mod_symbol_count > 0 %}
    {{ mod_symbol_count }} symbol{% if mod_symbol_count != 1 %}s{% endif %}
    {% endif %}
    • {% endfor %}
{% endif %}
{% endif %}
{% else %} {% for mod in group.modules %} {% set mod_class_count = mod.classes | length %} {% set mod_func_count = mod.functions | length %} {% set mod_symbol_count = mod_class_count + mod_func_count %}

{{ mod.name }}

{% if mod.docstring %} {{ mod.docstring | striptags | truncate(length=140) }} {% else %} No module description provided. {% endif %}

{% if mod_symbol_count > 0 %}
Show symbols ({{ mod_symbol_count }})
{% endif %}
{% endfor %} {% endif %} {% endfor %}