{% include "header.html" %} {% set role = page_role(state, entity) | replace(' ', '-') %}
Description {% set texts = other_sections(entity) | selectattr("kind", "equalto", "text") | list %} {% if texts %}
{% for section in texts %}{{ section.text | markdown | safe }}{% endfor %}
{% else %}

No docstring.

{% endif %}
Signature {% if entity.decorators %}

{% for decorator in entity.decorators %}@{{ decorator }}{% endfor %}

{% endif %}
{{ signature(entity) | highlight }}
{% if entity.kind == "class" and entity.bases %}

Bases: {% for base in entity.bases %}{{ base }}{% endfor %}

{% endif %}
{% set rows = parameter_rows(entity) %} {% if rows %}
Parameters {{ rows | length }} {% for row in rows %} {% endfor %}
NameTypeDefaultDescription
{{ row.name }} {% if row.annotation %}{{ row.annotation }}{% else %}-{% endif %} {% if row.default %}{{ row.default }}{% else %}-{% endif %} {% if row.description %}{{ row.description | markdown | safe }}{% else %}-{% endif %}
{% endif %} {% set documented = other_sections(entity) | rejectattr("kind", "equalto", "text") | list %} {% if entity.kind == "function" and entity.returns and not documented | selectattr("kind", "equalto", "returns") | list %}
Returns

{{ entity.returns }}

{% endif %} {% for section in documented %} {% set kind = section.kind | replace(' ', '-') %}
{{ section.title or section.kind }}{% if section["items"] | length > 1 %} {{ section["items"] | length }}{% endif %} {% if section.text %}{{ section.text | markdown | safe }}{% endif %} {% if section["items"] %} {% endif %}
{% endfor %} {% if entity.kind == "class" %} {% with divider = true %}{% include "members.html" %}{% endwith %} {% endif %} {# Open by default; the code is fetched right after the page is shown, so the page itself stays light. #}
Source {# Changing the theme saves it to doc/config/config.json. #}

Loading…