{% extends "base.html" %} {% from 'partials/reference-components.html' import reference_header, reference_metadata %} {% from 'partials/navigation-components.html' import breadcrumbs, page_navigation, toc with context %} {% from 'partials/content-components.html' import tag_list %} {# API Reference Single Page Template Three-column layout for individual API documentation pages: - Left sidebar: API navigation tree - Center: Content with class/function details - Right sidebar: TOC for quick navigation Usage: Automatically applied to pages in api-reference sections Or set `template: api-reference/single.html` in frontmatter #} {% block content %} {# Three-column documentation layout #}
{# Left Sidebar: API Navigation #} {# Main Content #}
{# Breadcrumbs #} {{ breadcrumbs(page) }} {# Article Content #}
{# Reference header with icon and title #} {{ reference_header( icon='📦', title=page.title, description=page.metadata.get('description', ''), type='api' ) }} {# Reference metadata box (module, source, etc.) #} {{ reference_metadata({ 'Module': page.metadata.get('module_path', ''), 'Source': page.metadata.get('source_file', '') }) }} {# Document metadata (last updated, etc) #} {% include 'partials/docs-meta.html' %}
{# Main content #}
{{ content | safe }}
{# Tags #} {% if page.tags %}
{{ tag_list(page.tags) }}
{% endif %}
{# Page navigation (prev/next module) at bottom #} {{ page_navigation(page) }}
{# Right Sidebar: TOC #} {% if toc_items %} {% endif %}
{# Mobile sidebar toggle button #} {# Sidebar overlay for mobile #} {% endblock %} {# Sidebar toggle functionality is handled by interactive.js #}