docs » {{ module.name }}

{{ module.doc_gfm }}
{% if module["submodules"]|length > 0 %}

Submodules

{% endif %}

API Overview

API Documentation

{% for type in type_order %} {% if module[type]|length > 0 %}

{{ type}}s

{% for item in module[type] %}
{{ item.name }}
{% if item.type == "Function" or item.type == "Method" or item.type == "Constructor" %} {% endif %} {% if item.notes|length > 0 %} {% endif %} {% if item.examples|length > 0 %} {% endif %}
Signature {{ item.def_gfm }}
Type {{ item.type }}
Description {{ item.desc_gfm }}
Parameters {{ item.parameters_gfm }}
Returns {{ item.returns_gfm }}
Notes {{ item.notes_gfm }}
Examples {{ item.examples_gfm }}
Source {{ item.file }} line {{ item.lineno }}
{% endfor %} {% endif %} {% endfor %}