{% extends "base.html" %}

{#- Docstring sections (Args, Returns, Raises, ...) taken out of a docstring:
    see `docstring::DocSections`. Descriptions are already rendered HTML. -#}
{% component doc_items(title, items) %}
<div class="doc-section">
    <p class="doc-section-title">{{ title }}</p>
    <ul class="doc-items">
        {%- for item in items %}
        <li class="doc-item">{% if item.name or item.type or item.default %}<span class="doc-item-head">{% if item.name %}<code class="doc-item-name">{{ item.name }}</code>{% endif %}{% if item.type %}<code class="doc-item-type">{% if item.type_html %}{{ item.type_html | safe }}{% else %}{{ item.type }}{% endif %}</code>{% endif %}{% if item.default %}<span class="doc-item-default">default <code>{{ item.default }}</code></span>{% endif %}</span>{% endif %}{% if item.description_html %}<div class="doc-item-text">{{ item.description_html | safe }}</div>{% endif %}</li>
        {%- endfor %}
    </ul>
</div>
{% endcomponent doc_items %}

{% component doc_sections(s) %}
<div class="doc-sections">
    {%- if s.params %}{{ <doc_items title="Parameters" items={s.params}/> }}{% endif %}
    {%- if s.keyword_params %}{{ <doc_items title="Keyword arguments" items={s.keyword_params}/> }}{% endif %}
    {%- if s.other_params %}{{ <doc_items title="Other parameters" items={s.other_params}/> }}{% endif %}
    {%- if s.attributes %}{{ <doc_items title="Attributes" items={s.attributes}/> }}{% endif %}
    {%- if s.returns %}{{ <doc_items title="Returns" items={s.returns}/> }}{% endif %}
    {%- if s.yields %}{{ <doc_items title="Yields" items={s.yields}/> }}{% endif %}
    {%- if s.raises %}{{ <doc_items title="Raises" items={s.raises}/> }}{% endif %}
    {%- for block in s.examples %}
    <div class="doc-section"><p class="doc-section-title">Examples</p>{{ block.html | safe }}</div>
    {%- endfor %}
    {%- for block in s.notes %}{{ block.html | safe }}{% endfor %}
    {%- for block in s.warnings %}{{ block.html | safe }}{% endfor %}
    {%- for block in s.see_also %}
    <div class="doc-section"><p class="doc-section-title">See also</p>{{ block.html | safe }}</div>
    {%- endfor %}
</div>
{% endcomponent doc_sections %}

{#- A class defined inside another class, rendered inside its parent's card.
    Anchors use the qualified name ("Outer.Inner"). Calls itself for deeper nesting. -#}
{% component nested_class(cls, @module, @source_url = "") %}
<div class="method-item" id="class.{{ cls.qualname }}">
    <div class="signature-box">
        <span class="signature-code"><span class="keyword">class</span> <span class="entity-name">{{ cls.qualname }}</span>{% if cls.bases %}({% if cls.linked %}{{ cls.linked.html | safe }}{% else %}{{ cls.bases | join(sep=", ") }}{% endif %}){% endif %}:</span>
        <span class="signature-meta">{% for badge in cls.badges %}<span class="badge">{{ badge }}</span>{% endfor %}{% if source_url %}<a class="source-ref" href="{{ source_url }}/{{ module.source_path }}#L{{ cls.line }}">source</a>{% else %}<span class="source-ref">line {{ cls.line }}</span>{% endif %}</span>
    </div>
    {% if cls.docstring %}<div class="docstring">{{ cls.docstring | safe }}</div>{% endif %}{% if cls.sections %}{{ <doc_sections s={cls.sections}/> }}{% endif %}
    {%- if cls.variables %}
    <div class="method-list">
        <h3 class="method-list-title">Attributes</h3>
        {%- for var in cls.variables %}
        <div class="method-item" id="attr.{{ cls.qualname }}.{{ var.name }}"><div class="signature-box"><span class="signature-code">{% if var.is_type_alias %}<span class="keyword">type</span> {% endif %}<span class="entity-name">{{ var.name }}</span>{% if var.annotation %}: {% if var.linked %}{{ var.linked.html | safe }}{% else %}{{ var.annotation }}{% endif %}{% endif %}{% if var.value %} = {{ var.value }}{% if var.value_truncated %}<span class="value-truncated" title="Value shortened">…</span>{% endif %}{% endif %}</span><span class="signature-meta">{% for badge in var.badges %}<span class="badge">{{ badge }}</span>{% endfor %}{% if source_url %}<a class="source-ref" href="{{ source_url }}/{{ module.source_path }}#L{{ var.line }}">source</a>{% else %}<span class="source-ref">line {{ var.line }}</span>{% endif %}</span></div>{% if var.docstring %}<div class="docstring">{{ var.docstring | safe }}</div>{% endif %}</div>
        {%- endfor %}
    </div>
    {%- endif %}
    {%- if cls.functions %}
    <div class="method-list">
        <h3 class="method-list-title">Methods</h3>
        {%- for func in cls.functions %}
        <div class="method-item" id="method.{{ cls.qualname }}.{{ func.name }}"><div class="signature-box"><span class="signature-code">{% if func.is_async %}<span class="keyword">async</span> {% endif %}<span class="keyword">def</span> <span class="entity-name">{{ func.name }}</span>({% if func.linked %}{{ func.linked.html | safe }}{% else %}{{ func.args | join(sep=", ") }}{% endif %}){% if func.return_type %} -> {% if func.linked %}{{ func.linked.return_type | safe }}{% else %}{{ func.return_type }}{% endif %}{% endif %}:</span><span class="signature-meta">{% for badge in func.badges %}<span class="badge">{{ badge }}</span>{% endfor %}{% if source_url %}<a class="source-ref" href="{{ source_url }}/{{ module.source_path }}#L{{ func.line }}">source</a>{% else %}<span class="source-ref">line {{ func.line }}</span>{% endif %}</span></div>{% if func.docstring %}<div class="docstring">{{ func.docstring | safe }}</div>{% endif %}{% if func.sections %}{{ <doc_sections s={func.sections}/> }}{% endif %}</div>
        {%- endfor %}
    </div>
    {%- endif %}
    {%- if cls.classes %}
    <div class="method-list">
        <h3 class="method-list-title">Nested classes</h3>
        {%- for inner in cls.classes %}
        {{ <nested_class cls={inner}/> }}
        {%- endfor %}
    </div>
    {%- endif %}
</div>
{% endcomponent nested_class %}

{#- Outline entries for a nested class and everything inside it. -#}
{% component outline_class(cls) %}
<li><a href="#class.{{ cls.qualname }}">{{ cls.qualname }}</a>
{%- if cls.variables or cls.functions or cls.classes %}<ul>
{%- for var in cls.variables %}<li><a href="#attr.{{ cls.qualname }}.{{ var.name }}">{{ var.name }}</a></li>{% endfor %}
{%- for func in cls.functions %}<li><a href="#method.{{ cls.qualname }}.{{ func.name }}">{{ func.name }}</a></li>{% endfor %}
{%- for inner in cls.classes %}{{ <outline_class cls={inner}/> }}{% endfor %}
</ul>{% endif %}</li>
{% endcomponent outline_class %}

{% block title %}Module {{ display_module_name }} - {{ package.name }}{% endblock title %}

{% block description %}{% if module.summary %}{{ module.summary }}{% else %}{{ display_module_name }} - {{ package.name }} documentation{% endif %}{% endblock description %}

{% block header %}
            <div class="namespace-path breadcrumb-row">
                <div>
                    <a href="{{ root_path }}index.html">{{ package.name }}</a> :: <span>{% if module.qualname %}{{ module.qualname }}{% else %}{{ display_module_name }}{% endif %}</span>
                </div>
                <a href="{{ root_path }}index.html" class="back-link">
                    ← Back to Overview
                </a>
            </div>

            <h1 class="module-title">
                {% if module.name == "__init__" %}Package{% else %}Module{% endif %}
                <span class="entity-name">{{ display_module_name }}</span>
            </h1>
{% endblock header %}

{% block content %}
            {% block module_docstring %}
            {% if module.docstring %}
                <div class="docstring">{{ module.docstring | safe }}</div>
            {% endif %}
            {% endblock module_docstring %}

            {% block variables %}
            {% if module.variables %}
            <section class="item-section">
                <h2>Variables</h2>
                {#- Cards are kept on one line each: large projects have thousands. -#}
                {%- for var in module.variables %}
                <div class="item-card" id="var.{{ var.name }}"><div class="signature-box"><span class="signature-code">{% if var.is_type_alias %}<span class="keyword">type</span> {% endif %}<span class="entity-name">{{ var.name }}</span>{% if var.annotation %}: {% if var.linked %}{{ var.linked.html | safe }}{% else %}{{ var.annotation }}{% endif %}{% endif %}{% if var.value %} = {{ var.value }}{% if var.value_truncated %}<span class="value-truncated" title="Value shortened">…</span>{% endif %}{% endif %}</span><span class="signature-meta">{% for badge in var.badges %}<span class="badge">{{ badge }}</span>{% endfor %}{% if source_url %}<a class="source-ref" href="{{ source_url }}/{{ module.source_path }}#L{{ var.line }}">source</a>{% else %}<span class="source-ref">{{ module.source_path }}:{{ var.line }}</span>{% endif %}</span></div>{% if var.docstring %}<div class="docstring">{{ var.docstring | safe }}</div>{% endif %}</div>
                {%- endfor %}
            </section>
            {% endif %}
            {% endblock variables %}

            {% block classes %}
            {% if module.classes %}
            <section class="item-section">
                <h2>Classes</h2>
                {% for class in module.classes %}
                    <div class="item-card" id="class.{{ class.name }}">
                        <div class="signature-box">
                            <span class="signature-code"><span class="keyword">class</span> <span class="entity-name">{{ class.name }}</span>{% if class.bases %}({% if class.linked %}{{ class.linked.html | safe }}{% else %}{{ class.bases | join(sep=", ") }}{% endif %}){% endif %}:</span>
                            <span class="signature-meta">{% for badge in class.badges %}<span class="badge">{{ badge }}</span>{% endfor %}{% if source_url %}<a class="source-ref" href="{{ source_url }}/{{ module.source_path }}#L{{ class.line }}">source</a>{% else %}<span class="source-ref">{{ module.source_path }}:{{ class.line }}</span>{% endif %}</span>
                        </div>
                        {% if class.docstring %}
                            <div class="docstring">{{ class.docstring | safe }}</div>
                        {% endif %}{% if class.sections %}{{ <doc_sections s={class.sections}/> }}{% endif %}

                        {% if class.variables %}
                            <div class="method-list">
                                <h3 class="method-list-title">Attributes</h3>
                                {%- for var in class.variables %}
                                <div class="method-item" id="attr.{{ class.name }}.{{ var.name }}"><div class="signature-box"><span class="signature-code">{% if var.is_type_alias %}<span class="keyword">type</span> {% endif %}<span class="entity-name">{{ var.name }}</span>{% if var.annotation %}: {% if var.linked %}{{ var.linked.html | safe }}{% else %}{{ var.annotation }}{% endif %}{% endif %}{% if var.value %} = {{ var.value }}{% if var.value_truncated %}<span class="value-truncated" title="Value shortened">…</span>{% endif %}{% endif %}</span><span class="signature-meta">{% for badge in var.badges %}<span class="badge">{{ badge }}</span>{% endfor %}{% if source_url %}<a class="source-ref" href="{{ source_url }}/{{ module.source_path }}#L{{ var.line }}">source</a>{% else %}<span class="source-ref">line {{ var.line }}</span>{% endif %}</span></div>{% if var.docstring %}<div class="docstring">{{ var.docstring | safe }}</div>{% endif %}</div>
                                {%- endfor %}
                            </div>
                        {% endif %}

                        {% if class.functions %}
                            <div class="method-list">
                                <h3 class="method-list-title">Methods</h3>
                                {% for func in class.functions %}
                                    <div class="method-item" id="method.{{ class.name }}.{{ func.name }}">
                                        <div class="signature-box">
                                            <span class="signature-code">{% if func.is_async %}<span class="keyword">async</span> {% endif %}<span class="keyword">def</span> <span class="entity-name">{{ func.name }}</span>({% if func.linked %}{{ func.linked.html | safe }}{% else %}{{ func.args | join(sep=", ") }}{% endif %}){% if func.return_type %} -> {% if func.linked %}{{ func.linked.return_type | safe }}{% else %}{{ func.return_type }}{% endif %}{% endif %}:</span>
                                            <span class="signature-meta">{% for badge in func.badges %}<span class="badge">{{ badge }}</span>{% endfor %}{% if source_url %}<a class="source-ref" href="{{ source_url }}/{{ module.source_path }}#L{{ func.line }}">source</a>{% else %}<span class="source-ref">line {{ func.line }}</span>{% endif %}</span>
                                        </div>
                                        {% if func.docstring %}
                                            <div class="docstring">{{ func.docstring | safe }}</div>
                                        {% endif %}{% if func.sections %}{{ <doc_sections s={func.sections}/> }}{% endif %}
                                    </div>
                                {% endfor %}
                            </div>
                        {% endif %}

                        {% if class.classes %}
                            <div class="method-list">
                                <h3 class="method-list-title">Nested classes</h3>
                                {%- for inner in class.classes %}
                                {{ <nested_class cls={inner}/> }}
                                {%- endfor %}
                            </div>
                        {% endif %}
                    </div>
                {% endfor %}
            </section>
            {% endif %}
            {% endblock classes %}

            {% block functions %}
            {% if module.functions %}
            <section class="item-section">
                <h2>Functions</h2>
                {% for func in module.functions %}
                    <div class="item-card" id="fn.{{ func.name }}">
                        <div class="signature-box">
                            <span class="signature-code">{% if func.is_async %}<span class="keyword">async</span> {% endif %}<span class="keyword">def</span> <span class="entity-name">{{ func.name }}</span>({% if func.linked %}{{ func.linked.html | safe }}{% else %}{{ func.args | join(sep=", ") }}{% endif %}){% if func.return_type %} -> {% if func.linked %}{{ func.linked.return_type | safe }}{% else %}{{ func.return_type }}{% endif %}{% endif %}:</span>
                            <span class="signature-meta">{% for badge in func.badges %}<span class="badge">{{ badge }}</span>{% endfor %}{% if source_url %}<a class="source-ref" href="{{ source_url }}/{{ module.source_path }}#L{{ func.line }}">source</a>{% else %}<span class="source-ref">{{ module.source_path }}:{{ func.line }}</span>{% endif %}</span>
                        </div>
                        {% if func.docstring %}
                            <div class="docstring">{{ func.docstring | safe }}</div>
                        {% endif %}{% if func.sections %}{{ <doc_sections s={func.sections}/> }}{% endif %}
                    </div>
                {% endfor %}
            </section>
            {% endif %}
            {% endblock functions %}
{% endblock content %}

{% block outline %}
    {% if module.variables or module.classes or module.functions %}
    <aside class="page-outline" aria-label="On this page">
        <div class="outline-title">On this page</div>
        <ul>
            {%- for var in module.variables %}
            <li><a href="#var.{{ var.name }}">{{ var.name }}</a></li>
            {%- endfor %}
            {% for class in module.classes %}
                <li>
                    <a href="#class.{{ class.name }}">{{ class.name }}</a>
                    {% if class.variables or class.functions or class.classes %}
                        <ul>
                            {%- for var in class.variables %}
                            <li><a href="#attr.{{ class.name }}.{{ var.name }}">{{ var.name }}</a></li>
                            {%- endfor %}
                            {% for func in class.functions %}
                                <li><a href="#method.{{ class.name }}.{{ func.name }}">{{ func.name }}</a></li>
                            {% endfor %}
                            {%- for inner in class.classes %}
                            {{ <outline_class cls={inner}/> }}
                            {%- endfor %}
                        </ul>
                    {% endif %}
                </li>
            {% endfor %}
            {% for func in module.functions %}
                <li><a href="#fn.{{ func.name }}">{{ func.name }}</a></li>
            {% endfor %}
        </ul>
    </aside>
    {% endif %}
{% endblock outline %}