{# SPDX-License-Identifier: MIT #}
{% extends "basic/layout.html" %}
{% from "components.html" import drawer, drawer_trigger, relation_link with context %}

{# Python supplies one validated option model for templates and behavior. #}
{% set caffy_options = caffy_theme_options|default({}, true) %}
{% set caffy_color_mode = caffy_options.color_mode|default('auto', true) %}
{% set caffy_accent = caffy_options.accent|default('amber', true) %}
{% set caffy_navigation_depth = caffy_options.navigation_depth|default(3, true) %}
{% set caffy_show_page_toc = caffy_options.show_page_toc|default(true) %}
{% set caffy_has_page_toc = caffy_show_page_toc and caffy_has_page_toc|default(false) %}
{% set html_tag -%}
<html{% if language is defined and language is not none %} lang="{{ language|e }}"{% endif %} data-content_root="{{ content_root|default('./', true)|e }}" data-caffy-color-mode="{{ caffy_color_mode|e }}" data-caffy-accent="{{ caffy_accent|e }}">
{%- endset %}

{% set caffy_page_kind = caffy_page_kind|default('document', true)|lower %}
{% set caffy_page_roles = caffy_page_roles|default(()) %}

{% if root_doc is defined %}
  {% set caffy_root_doc = root_doc %}
{% elif master_doc is defined %}
  {% set caffy_root_doc = master_doc %}
{% else %}
  {% set caffy_root_doc = 'index' %}
{% endif %}

{% if caffy_global_toc is defined %}
  {% set caffy_global_toc = caffy_global_toc %}
{% elif toctree is defined %}
  {% set caffy_global_toc = toctree(collapse=false, includehidden=true, maxdepth=caffy_navigation_depth, titles_only=true) %}
{% else %}
  {% set caffy_global_toc = '' %}
{% endif %}
{% set caffy_has_global_nav = caffy_global_toc|striptags|trim %}

{% if shorttitle is defined and shorttitle %}
  {% set caffy_brand_name = shorttitle %}
{% elif project is defined and project %}
  {% set caffy_brand_name = project %}
{% else %}
  {% set caffy_brand_name = 'Documentation' %}
{% endif %}

{% block css %}
  <meta name="color-scheme" content="{% if caffy_color_mode == 'auto' %}light dark{% else %}{{ caffy_color_mode|e }}{% endif %}">
  <script data-caffy-color-bootstrap>
    (function () {
      var root = document.documentElement;
      var modes = ["auto", "light", "dark"];
      var configured = root.getAttribute("data-caffy-color-mode") || "auto";

      function restoreMode() {
        var stored = null;
        try {
          stored = window.localStorage.getItem("caffy-color-mode");
        } catch (error) {
          /* Storage may be unavailable in private or embedded browsing contexts. */
        }

        var mode = modes.indexOf(stored) !== -1
          ? stored
          : modes.indexOf(configured) !== -1
            ? configured
            : "auto";
        var scheme = mode === "auto" ? "light dark" : mode;
        var schemeMeta = document.querySelector('meta[name="color-scheme"]');
        var darkHighlight = document.querySelector("#pygments_dark_css");

        root.setAttribute("data-caffy-color-mode", mode);
        root.style.colorScheme = scheme;
        if (schemeMeta) {
          schemeMeta.content = scheme;
        }
        if (darkHighlight) {
          darkHighlight.media = mode === "dark"
            ? "all"
            : mode === "light"
              ? "not all"
              : "(prefers-color-scheme: dark)";
        }
      }

      restoreMode();
      window.addEventListener("pagereveal", restoreMode);
      window.addEventListener("pageshow", restoreMode);
    }());
  </script>
  {{ super() }}
  <script data-caffy-highlight-bootstrap>
    (function () {
      var mode = document.documentElement.getAttribute("data-caffy-color-mode") || "auto";
      var darkHighlight = document.querySelector("#pygments_dark_css");
      if (darkHighlight) {
        darkHighlight.media = mode === "dark"
          ? "all"
          : mode === "light"
            ? "not all"
            : "(prefers-color-scheme: dark)";
      }
    }());
  </script>
{% endblock %}

{% block extrahead %}
  {{ super() }}
  {% if favicon_url is not defined or not favicon_url %}
    <link rel="icon" href="{{ pathto('_static/caffy-mark.svg', 1)|e }}" type="image/svg+xml">
  {% endif %}
  {% for name, label in caffy_runtime_labels.items() %}
    <meta data-caffy-label="{{ name|e }}" content="{{ label|e }}">
  {% endfor %}
  {% if caffy_object_kinds_json|default('', true) %}
    <meta data-caffy-object-kinds content="{{ caffy_object_kinds_json|e }}">
  {% endif %}
{% endblock %}

{% block body_tag %}<body class="caffy-page caffy-page-kind-{{ caffy_page_kind|e }}{% for role in caffy_page_roles %} caffy-page-role-{{ role|e }}{% endfor %}{% if caffy_api_title|default(false) %} caffy-page-api-title{% endif %}">{% endblock %}

{% block relbar1 %}{% endblock %}
{% block relbar2 %}{% endblock %}
{% block sidebar1 %}{% endblock %}
{% block sidebar2 %}{% endblock %}

{% block document %}
  <a class="caffy-skip-link" href="#main-content">{{ caffy_labels.skip_content }}</a>

  <div class="caffy-page-shell">
    <header class="caffy-header" data-caffy-header>
      <div class="caffy-header-inner">
        <a class="caffy-brand" href="{{ pathto(caffy_root_doc)|e }}" aria-label="{{ caffy_labels.brand_home|format(brand=caffy_brand_name|striptags)|e }}">
          {% if logo_url is defined and logo_url %}
            <img class="caffy-brand-logo" src="{{ logo_url|e }}" alt="">
          {% else %}
              <svg class="caffy-brand-mark" viewBox="0 0 64 64" aria-hidden="true" focusable="false">
                <defs>
                  <clipPath id="caffy-brand-facet-left"><path d="M37 5C24 2 11 12 8 27C5 43 14 57 29 61C22.5 52 23 42 27.8 33C32.2 23.3 38 13.7 37 5Z"></path></clipPath>
                  <clipPath id="caffy-brand-facet-right"><path d="M40 6C53 12 59 27 55 42C51 56 39 63 29 61C36 52 40 43 41 33C42 21 41 12 40 6Z"></path></clipPath>
                </defs>
                <path class="caffy-brand-mark-latte" d="M37 5C24 2 11 12 8 27C5 43 14 57 29 61C22.5 52 23 42 27.8 33C32.2 23.3 38 13.7 37 5Z"></path>
                <path class="caffy-brand-mark-roast" d="M40 6C53 12 59 27 55 42C51 56 39 63 29 61C36 52 40 43 41 33C42 21 41 12 40 6Z"></path>
                <g clip-path="url(#caffy-brand-facet-left)">
                  <path class="caffy-brand-mark-facet caffy-brand-mark-latte-light" d="M0 0H64L50.2 2Q1.3 8.8 18.5 57.6L0 57.6V0Z"></path>
                  <path class="caffy-brand-mark-facet caffy-brand-mark-latte" d="M0 57.6L18.5 57.6Q1.3 8.8 50.2 2L64 64H0Z"></path>
                </g>
                <g clip-path="url(#caffy-brand-facet-right)">
                  <path class="caffy-brand-mark-facet caffy-brand-mark-copper" d="M0 0H64V64L47.1 64Q64 29.5 39.9 5.7Z"></path>
                  <path class="caffy-brand-mark-facet caffy-brand-mark-roast" d="M47.1 64Q64 29.5 39.9 5.7Q55.8 41.8 37.7 63.6L64 63.6V64H47.1Z"></path>
                  <path class="caffy-brand-mark-facet caffy-brand-mark-espresso" d="M64 64H0L39.9 5.7Q55.8 41.8 37.7 63.6L64 63.6Z"></path>
                </g>
              </svg>
          {% endif %}
          <span class="caffy-brand-name">{{ caffy_brand_name|striptags|e }}</span>
        </a>

        {% if builder != 'singlehtml' %}
          <form class="caffy-search" action="{{ pathto('search')|e }}" method="get" role="search" data-caffy-search-suggestions data-caffy-searchtools-url="{{ pathto('_static/searchtools.js', 1)|e }}" data-caffy-language-data-url="{{ pathto('_static/language_data.js', 1)|e }}" data-caffy-searchindex-url="{{ pathto('searchindex.js', 1)|e }}" data-caffy-suggestions-count="{{ caffy_labels.suggestions_available|e }}">
            <label class="caffy-visually-hidden" for="caffy-search-input">{{ caffy_labels.search_documentation }}</label>
            <input id="caffy-search-input" type="search" name="q" placeholder="{{ caffy_labels.search_documentation|e }}" enterkeyhint="search" spellcheck="false" autocomplete="off" role="combobox" aria-autocomplete="list" aria-controls="caffy-search-suggestions-list" aria-expanded="false">
            <button class="caffy-search-clear" type="button" aria-label="{{ caffy_labels.clear_search|e }}" aria-controls="caffy-search-input" data-caffy-search-clear hidden><span class="caffy-search-clear-icon" aria-hidden="true"></span></button>
            <button class="caffy-search-submit" type="submit">{{ _('Search') }}</button>
            <div class="caffy-search-suggestions" hidden>
              <ul id="caffy-search-suggestions-list" role="listbox" aria-label="{{ caffy_labels.search_suggestions|e }}"></ul>
              <span class="caffy-visually-hidden" role="status" aria-live="polite" data-caffy-search-suggestions-status></span>
            </div>
          </form>
        {% endif %}

        <div class="caffy-header-actions">
          {% if caffy_version_manifest|default({}) %}
            <details class="caffy-version-switcher" data-caffy-choice-menu data-caffy-version-menu data-caffy-version-manifest data-caffy-version-manifest-url="{{ caffy_version_manifest.url|e }}" data-caffy-version-current="{{ caffy_version_manifest.current_version|e }}" data-caffy-version-page="{{ caffy_version_manifest.page_path|e }}" data-caffy-version-manifest-state="loading" hidden>
              <summary aria-label="{{ caffy_labels.versions|e }}">
                <span data-caffy-version-label>{{ caffy_version_manifest.current_version|e }}</span>
              </summary>
              <nav class="caffy-version-menu" aria-label="{{ caffy_labels.versions|e }}" data-caffy-version-list></nav>
            </details>
          {% elif caffy_version_links|default(()) %}
            <details class="caffy-version-switcher" data-caffy-choice-menu data-caffy-version-menu>
              <summary aria-label="{{ caffy_labels.versions|e }}">
                {% for item in caffy_version_links %}
                  {% if item.current %}<span>{{ item.label|e }}</span>{% endif %}
                {% endfor %}
              </summary>
              <nav class="caffy-version-menu" aria-label="{{ caffy_labels.versions|e }}">
                {% for item in caffy_version_links %}
                  <a href="{{ item.url|e }}"{% if item.current %} aria-current="page"{% endif %}>
                    <span>{{ item.label|e }}</span>
                  </a>
                {% endfor %}
              </nav>
            </details>
          {% endif %}
          {% if caffy_language_links|default(()) %}
            <details class="caffy-language-switcher" data-caffy-choice-menu data-caffy-language-menu>
              <summary aria-label="{{ caffy_labels.languages|e }}">
                {% for item in caffy_language_links %}
                  {% if item.current %}<span>{{ item.label|e }}</span>{% endif %}
                {% endfor %}
              </summary>
              <nav class="caffy-language-menu" aria-label="{{ caffy_labels.languages|e }}">
                {% for item in caffy_language_links %}
                  <a href="{{ item.url|e }}" hreflang="{{ item.code|e }}" lang="{{ item.code|e }}"{% if item.current %} aria-current="page"{% endif %}>
                    <span>{{ item.label|e }}</span>
                    <span class="caffy-language-menu-code" aria-hidden="true">{{ item.code|upper|e }}</span>
                  </a>
                {% endfor %}
              </nav>
            </details>
          {% endif %}
          <button class="caffy-header-button caffy-mode-button" type="button" data-caffy-color-toggle>
            <span class="caffy-mode-indicator" aria-hidden="true">
              <svg class="caffy-mode-icon caffy-mode-icon-auto" viewBox="0 0 16 16" focusable="false">
                <circle cx="8" cy="8" r="5.5"></circle>
                <path class="caffy-mode-icon-fill" d="M8 2.5a5.5 5.5 0 0 1 0 11Z"></path>
              </svg>
              <svg class="caffy-mode-icon caffy-mode-icon-light" viewBox="0 0 16 16" focusable="false">
                <circle cx="8" cy="8" r="2.4"></circle>
                <path d="M8 1.5v1.3M8 13.2v1.3M1.5 8h1.3M13.2 8h1.3M3.4 3.4l.9.9M11.7 11.7l.9.9M12.6 3.4l-.9.9M4.3 11.7l-.9.9"></path>
              </svg>
              <svg class="caffy-mode-icon caffy-mode-icon-dark" viewBox="0 0 16 16" focusable="false">
                <path d="M12.8 10.6A5.7 5.7 0 0 1 5.4 3.2a5.7 5.7 0 1 0 7.4 7.4Z"></path>
              </svg>
            </span>
            <span class="caffy-button-label" data-caffy-mode-label>{{ caffy_labels.mode_auto }}</span>
          </button>
          {% if caffy_has_global_nav %}
            {{ drawer_trigger('navigation', 'caffy-global-navigation', 'caffy-nav-trigger', 'caffy-button-glyph-menu', _('Navigation')) }}
          {% endif %}
          {% if caffy_has_page_toc %}
            {{ drawer_trigger('page-toc', 'caffy-page-toc', 'caffy-toc-trigger', 'caffy-button-glyph-toc', caffy_labels.on_this_page) }}
          {% endif %}
        </div>
      </div>
    </header>

    <div class="caffy-workspace{% if not caffy_has_global_nav %} caffy-workspace-no-nav{% endif %}{% if not caffy_has_page_toc %} caffy-workspace-no-toc{% endif %}">
      {% if caffy_has_global_nav %}
        {% call drawer('caffy-global-navigation', 'caffy-global-nav', 'navigation', _('Navigation'), _('Close'), caffy_labels.documentation_navigation, 'caffy-nav-tree', caffy_labels.documentation) %}
          {{ caffy_global_toc }}
        {% endcall %}
      {% endif %}

      <main id="main-content" class="caffy-main" role="main" tabindex="-1">
        <nav class="caffy-breadcrumbs" aria-label="{{ caffy_labels.breadcrumb|e }}">
          <ol>
            <li><a href="{{ pathto(caffy_root_doc)|e }}">{{ caffy_brand_name|striptags|e }}</a></li>
            {% if parents is defined %}
              {% for parent in parents %}
                <li><a{% if parent.link in caffy_api_name_routes|default(()) %} class="caffy-breadcrumb-api-name"{% endif %} href="{{ parent.link|e }}">{{ parent.title|striptags|e }}</a></li>
              {% endfor %}
            {% endif %}
            {% if pagename != caffy_root_doc %}
              <li{% if caffy_api_title|default(false) %} class="caffy-breadcrumb-api-name"{% endif %} aria-current="page">{{ title|default('Current page')|striptags|e }}</li>
            {% endif %}
          </ol>
        </nav>

        <article class="caffy-article">
          {% block body %}{% endblock %}
        </article>

        {% if prev or next %}
          <nav class="caffy-page-links" aria-label="{{ caffy_labels.previous_next|e }}">
            {% if prev %}
              {{ relation_link('prev', prev, caffy_labels.previous, prev.link in caffy_api_name_routes|default(())) }}
            {% endif %}
            {% if next %}
              {{ relation_link('next', next, caffy_labels.next, next.link in caffy_api_name_routes|default(())) }}
            {% endif %}
          </nav>
        {% endif %}
      </main>

      {% if caffy_has_page_toc %}
        {% call drawer('caffy-page-toc', 'caffy-page-toc', 'page-toc', caffy_labels.on_this_page, _('Close'), caffy_labels.on_this_page, 'caffy-page-toc-tree', caffy_labels.page_contents) %}
          {{ toc }}
        {% endcall %}
      {% endif %}
    </div>

    <footer class="caffy-footer">
      <div class="caffy-footer-inner">
        {% set caffy_show_copyright = show_copyright is not defined or show_copyright %}
        {% set caffy_show_sphinx = show_sphinx is not defined or show_sphinx %}
        {% if (caffy_show_copyright and copyright is defined and copyright) or caffy_show_sphinx or (last_updated is defined and last_updated) %}
          <span>
            {% if caffy_show_copyright and copyright is defined and copyright %}© {{ copyright|striptags|e }}{% endif %}
            {% if caffy_show_copyright and copyright is defined and copyright and (caffy_show_sphinx or (last_updated is defined and last_updated)) %} · {% endif %}
            {% if caffy_show_sphinx %}{{ caffy_labels.built_with }} <a href="https://www.sphinx-doc.org/" rel="external">Sphinx</a>{% endif %}
            {% if caffy_show_sphinx and last_updated is defined and last_updated %} · {% endif %}
            {% if last_updated is defined and last_updated %}{{ _('Last updated on %(last_updated)s.')|format(last_updated=last_updated|e) }}{% elif caffy_show_sphinx %}.{% endif %}
          </span>
        {% endif %}
        {% if show_source is defined and show_source and has_source is defined and has_source and sourcename is defined and sourcename %}
          <a href="{{ pathto('_sources/' ~ sourcename, 1)|e }}" rel="nofollow">{{ caffy_labels.view_source }}</a>
        {% endif %}
      </div>
    </footer>

    <button class="caffy-drawer-overlay" type="button" data-caffy-drawer-overlay aria-label="{{ caffy_labels.close_navigation|e }}" aria-hidden="true" tabindex="-1" hidden></button>
  </div>
{% endblock %}

{% block footer %}{% endblock %}