{% extends "base.html" %}

{% from "chirpui/rendered_content.html" import rendered_content %}
{% from "chirpui/layout.html" import grid %}
{% from "chirpui/callout.html" import callout %}
{% from "partials/navigation-components.html" import page_navigation %}
{% from "autodoc/partials/_macros/function-member.html" import function_member %}
{% from "autodoc/partials/_macros/class-member.html" import class_member %}

{% block content %}
{% let element = element | default(metadata?.autodoc_element ?? none) %}
{% let symbols = element?.children ?? [] %}
{% let source_file = element?.source_file ?? none %}
{% let source_line = element?.line_number ?? none %}
{% let github_edit_base = config?.params?.github_edit_base ?? config?.github_edit_base ?? none %}
{% let repo_url = config?.params?.repo_url ?? config?.repo_url ?? none %}
{% let source_href = (github_edit_base ~ source_file) if (github_edit_base and source_file) else ((repo_url ~ "/blob/main/" ~ source_file ~ ("#L" ~ source_line if source_line else "")) if (repo_url and source_file) else none) %}
{# Autodoc pages rarely carry prose toc_items, but a multi-member module gets a
   dedicated on-page symbol rail so the right aside (and its sticky styling) is
   used to jump between members. See #160. #}
{% let has_symbol_rail = (toc_items | length == 0) and (symbols | length > 0) %}
{% let show_toc_rail = (toc_items | length > 0) or has_symbol_rail %}
<div class="chirp-theme-docs-layout{{ ' chirp-theme-docs-layout--with-toc' if show_toc_rail else '' }}" data-chirp-theme-surface="api-reference">
<aside class="chirp-theme-docs-layout__sidebar" id="docs-sidebar">
  {% include 'partials/docs-nav.html' %}
</aside>
<div class="chirp-theme-docs-layout__main">

{% include "autodoc/partials/header.html" %}

<article class="prose chirp-theme-docs-layout__article chirp-theme-reference-page chirp-theme-reference-page--python">
  <div class="docs-content chirp-theme-docs-layout__content chirp-theme-reference-content">
    {% include "autodoc/partials/signature.html" %}
    {% include "autodoc/partials/badges.html" %}
    {% if element?.deprecated ?? none %}
    {% call callout(variant="warning", title="Deprecated", cls="chirp-theme-reference-deprecated") %}{{ element.deprecated | safe }}{% end %}
    {% end %}
    {% if element?.description ?? none %}
    {% call rendered_content(compact=true, cls="chirp-theme-reference-description") %}{{ element.description |> markdownify |> safe }}{% end %}
    {% end %}
    {% include "autodoc/partials/params-table.html" %}
    {% include "autodoc/partials/returns.html" %}
    {% include "autodoc/partials/raises.html" %}
    {% if symbols | length > 0 %}
    <section class="chirp-theme-reference-section chirp-theme-reference-symbols">
      <h2>Symbols on this page</h2>
      {% call grid(cols=2, gap="md", cls="chirp-theme-reference-symbol-grid") %}
        {% for symbol in symbols %}
        {% let symbol_kind = symbol?.element_type ?? "member" %}
        {% if symbol_kind == "class" %}{{ class_member(symbol) }}{% else %}{{ function_member(symbol) }}{% end %}
        {% end %}
      {% end %}
    </section>
    {% end %}
    {% include "autodoc/partials/members.html" %}
    {% include "autodoc/partials/examples.html" %}
    {% if source_href %}
    <p class="chirp-theme-reference-source">
      <a href="{{ source_href }}" class="chirp-theme-reference-source__link" target="_blank" rel="noopener">
        {{ icon('code', size=14) }} <span>View source{% if source_file %} · {{ source_file }}{% if source_line %}:{{ source_line }}{% end %}{% end %}</span>
      </a>
    </p>
    {% end %}
  </div>
</article>

{% if page %}{{ page_navigation(page) }}{% end %}

{% with footer_class='chirp-theme-footer chirp-theme-footer--shell' %}{% include 'partials/site-footer.html' %}{% end %}

</div>
{% if show_toc_rail %}
<aside class="chirp-theme-docs-layout__toc" role="complementary" aria-label="{{ 'Symbols on this page' if has_symbol_rail else 'Table of contents' }}">
{% if has_symbol_rail %}
<div class="chirpui-nav-tree toc-sidebar chirp-theme-doc-toc chirp-theme-symbol-rail" data-bengal="toc" data-symbol-rail>
  <div class="chirp-theme-doc-toc__context">
    <span class="chirp-theme-doc-toc__context-mark" aria-hidden="true">{{ icon('code', size=16) }}</span>
    <div class="chirp-theme-doc-toc__context-copy">
      <span class="chirp-theme-doc-toc__eyebrow">Symbols</span>
      <strong>{{ element?.name ?? page?.title ?? 'This module' }}</strong>
    </div>
    <span class="chirp-theme-doc-toc__context-count chirp-theme-doc-toc__count-pill" aria-label="{{ symbols | length }} symbols">{{ symbols | length }}</span>
  </div>
  <nav class="chirp-theme-doc-toc__nav" aria-label="Symbols on this page" data-toc-mode="normal">
    <div class="chirp-theme-doc-toc__scroll">
      <ul class="chirpui-nav-tree__list toc-items chirp-theme-doc-toc__items chirp-theme-symbol-rail__items" role="list">
        {% for symbol in symbols %}
        {% let symbol_name = symbol?.name ?? symbol?.title ?? "Member" %}
        {% let symbol_kind = symbol?.element_type ?? symbol?.type ?? "member" %}
        {% let symbol_icon = "cube" if symbol_kind == "class" else ("function" if symbol_kind in ["function", "method"] else ("tag" if symbol_kind in ["property", "attribute"] else "code")) %}
        <li class="chirpui-nav-tree__item toc-item chirp-theme-doc-toc__item chirp-theme-symbol-rail__item" role="listitem">
          <a href="#{{ symbol_name }}"
             class="chirpui-nav-tree__link chirpui-nav-tree__link--leaf toc-link chirp-theme-doc-toc__link chirp-theme-symbol-rail__link"
             data-toc-item="#{{ symbol_name }}"
             data-symbol-link
             title="{{ symbol_kind }} {{ symbol_name }}">
            <span class="chirp-theme-doc-toc__mark chirp-theme-symbol-rail__mark" aria-hidden="true" data-symbol-kind="{{ symbol_kind }}">{{ icon(symbol_icon, size=13) }}</span>
            <span class="chirp-theme-doc-toc__label chirp-theme-symbol-rail__label">{{ symbol_name }}</span>
          </a>
        </li>
        {% end %}
      </ul>
    </div>
  </nav>
</div>
{% else %}
{% include 'partials/docs-toc-sidebar.html' %}
{% end %}
</aside>
{% end %}
</div>

<button class="docs-sidebar-toggle" aria-label="Toggle navigation sidebar" aria-expanded="false"
  aria-controls="docs-sidebar">
  {{ icon('list', size=20) }}
</button>
<div class="docs-sidebar-overlay" aria-hidden="true"></div>
{% end %}

{% block site_footer %}{% end %}