| 1 |
{# |
| 2 |
Copyright (c) 2020 Pradyun Gedam <[email protected]> |
| 3 |
|
| 4 |
Permission is hereby granted, free of charge, to any person obtaining a copy |
| 5 |
of this software and associated documentation files (the "Software"), to |
| 6 |
deal in the Software without restriction, including without limitation the |
| 7 |
rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 8 |
sell copies of the Software, and to permit persons to whom the Software is |
| 9 |
furnished to do so, subject to the following conditions: |
| 10 |
#} |
| 11 |
|
| 12 |
{% extends "!page.html" %} |
| 13 |
|
| 14 |
{%- block extrahead %} |
| 15 |
<script src="https://a0.awsstatic.com/s_code/js/3.0/awshome_s_code.js"></script> |
| 16 |
<script src="https://prod.assets.shortbread.aws.dev/shortbread.js"></script> |
| 17 |
<link href="https://prod.assets.shortbread.aws.dev/shortbread.css" rel="stylesheet"> |
| 18 |
{% endblock %} |
| 19 |
|
| 20 |
{% block body -%} |
| 21 |
{% include 'partials/icons.html' %} |
| 22 |
<svg xmlns="http://www.w3.org/2000/svg" class="hidden"> |
| 23 |
<symbol id="svg-close" viewBox="0 0 24 24"> |
| 24 |
<title>Close Menu</title> |
| 25 |
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" stroke="currentColor" |
| 26 |
stroke-width="3" stroke-linecap="round" stroke-linejoin="round" class="feather-menu"> |
| 27 |
<line x1="2" y1="22" x2="22" y2="2"/> |
| 28 |
<line x1="2" y1="2" x2="22" y2="22"/> |
| 29 |
</svg> |
| 30 |
</symbol> |
| 31 |
</svg> |
| 32 |
|
| 33 |
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation"> |
| 34 |
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc"> |
| 35 |
<label class="overlay sidebar-overlay" for="__navigation"> |
| 36 |
<div class="visually-hidden">Hide navigation sidebar</div> |
| 37 |
</label> |
| 38 |
<label class="overlay toc-overlay" for="__toc"> |
| 39 |
<div class="visually-hidden">Hide table of contents sidebar</div> |
| 40 |
</label> |
| 41 |
|
| 42 |
<a class="skip-to-content muted-link" href="#furo-main-content"> |
| 43 |
{%- trans -%} |
| 44 |
Skip to content |
| 45 |
{%- endtrans -%} |
| 46 |
</a> |
| 47 |
|
| 48 |
{% if theme_announcement -%} |
| 49 |
<div class="announcement"> |
| 50 |
<aside class="announcement-content"> |
| 51 |
{% block announcement %} {{ theme_announcement }} {% endblock announcement %} |
| 52 |
</aside> |
| 53 |
</div> |
| 54 |
{%- endif %} |
| 55 |
|
| 56 |
<div class="page"> |
| 57 |
<header class="mobile-header"> |
| 58 |
<div class="header-left"> |
| 59 |
<label class="nav-overlay-icon" id="nav-menu-open" for="__navigation" tabindex="0"> |
| 60 |
<div class="visually-hidden">Toggle site navigation sidebar</div> |
| 61 |
<i class="icon"><svg><use href="#svg-menu"></use></svg></i> |
| 62 |
</label> |
| 63 |
</div> |
| 64 |
<div class="header-center"> |
| 65 |
<a href="{{ pathto(master_doc) }}"><div class="brand">{{ docstitle if docstitle else project }}</div></a> |
| 66 |
</div> |
| 67 |
<div class="header-right"> |
| 68 |
<div class="theme-toggle-container theme-toggle-header"> |
| 69 |
<button class="theme-toggle"> |
| 70 |
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> |
| 71 |
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> |
| 72 |
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> |
| 73 |
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> |
| 74 |
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> |
| 75 |
</button> |
| 76 |
</div> |
| 77 |
<label class="toc-overlay-icon toc-header-icon{% if furo_hide_toc %} no-toc{% endif %}" id="toc-menu-open-sm" for="__toc" tabindex="0"> |
| 78 |
<div class="visually-hidden">Toggle table of contents sidebar</div> |
| 79 |
<i class="icon"><svg><use href="#svg-toc"></use></svg></i> |
| 80 |
</label> |
| 81 |
</div> |
| 82 |
</header> |
| 83 |
<aside class="sidebar-drawer"> |
| 84 |
<div class="sidebar-container"> |
| 85 |
{% block left_sidebar %} |
| 86 |
<div class="sidebar-sticky"> |
| 87 |
{%- for sidebar_section in sidebars %} |
| 88 |
{%- include sidebar_section %} |
| 89 |
{%- endfor %} |
| 90 |
</div> |
| 91 |
{% endblock left_sidebar %} |
| 92 |
</div> |
| 93 |
</aside> |
| 94 |
<div class="main"> |
| 95 |
<div class="content"> |
| 96 |
<div class="article-container"> |
| 97 |
<a href="#" class="back-to-top muted-link"> |
| 98 |
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"> |
| 99 |
<path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path> |
| 100 |
</svg> |
| 101 |
<span>{% trans %}Back to top{% endtrans %}</span> |
| 102 |
</a> |
| 103 |
<div class="content-icon-container"> |
| 104 |
{% if theme_top_of_page_button != "edit" -%} |
| 105 |
{{ warning("Got configuration for 'top_of_page_button': this is deprecated.") }} |
| 106 |
{%- endif -%} |
| 107 |
|
| 108 |
{%- if theme_top_of_page_buttons == "" -%} |
| 109 |
{% if theme_top_of_page_button == None -%} |
| 110 |
{#- We respect the old configuration of disabling all the buttons -#} |
| 111 |
{%- set theme_top_of_page_buttons = [] -%} |
| 112 |
{% else %} |
| 113 |
{%- set theme_top_of_page_buttons = ["view", "edit"] -%} |
| 114 |
{%- endif -%} |
| 115 |
{% else -%} |
| 116 |
{% if theme_top_of_page_button != "edit" -%} |
| 117 |
{%- set theme_top_of_page_buttons = [] -%} |
| 118 |
{{ warning("Got configuration for both 'top_of_page_button' and 'top_of_page_buttons', ignoring both and removing all top of page buttons.") }} |
| 119 |
{%- endif -%} |
| 120 |
{%- endif -%} |
| 121 |
{% for button in theme_top_of_page_buttons -%} |
| 122 |
{% if button == "view" %} |
| 123 |
{%- include "components/view-this-page.html" with context -%} |
| 124 |
{% elif button == "edit" %} |
| 125 |
{%- include "components/edit-this-page.html" with context -%} |
| 126 |
{% else %} |
| 127 |
{{ warning("Got an unsupported value in 'top_of_page_buttons' for theme configuration") }} |
| 128 |
{% endif %} |
| 129 |
{%- endfor -%} |
| 130 |
{#- Theme toggle -#} |
| 131 |
<div class="theme-toggle-container theme-toggle-content"> |
| 132 |
<button class="theme-toggle"> |
| 133 |
<div class="visually-hidden">Toggle Light / Dark / Auto color theme</div> |
| 134 |
<svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg> |
| 135 |
<svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg> |
| 136 |
<svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg> |
| 137 |
<svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg> |
| 138 |
</button> |
| 139 |
</div> |
| 140 |
<label class="toc-overlay-icon toc-content-icon{% if furo_hide_toc %} no-toc{% endif %}" id="toc-menu-open-md" for="__toc" tabindex="0"> |
| 141 |
<div class="visually-hidden">Toggle table of contents sidebar</div> |
| 142 |
<i class="icon"><svg><use href="#svg-toc"></use></svg></i> |
| 143 |
</label> |
| 144 |
</div> |
| 145 |
<article role="main" id="furo-main-content"> |
| 146 |
{% block content %}{{ body }}{% endblock %} |
| 147 |
</article> |
| 148 |
</div> |
| 149 |
<footer> |
| 150 |
{% block footer %} |
| 151 |
<div class="related-pages"> |
| 152 |
{% if next -%} |
| 153 |
<a class="next-page" href="{{ next.link }}"> |
| 154 |
<div class="page-info"> |
| 155 |
<div class="context"> |
| 156 |
<span>{{ _("Next") }}</span> |
| 157 |
</div> |
| 158 |
<div class="title">{{ next.title }}</div> |
| 159 |
</div> |
| 160 |
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> |
| 161 |
</a> |
| 162 |
{%- endif %} |
| 163 |
{% if prev -%} |
| 164 |
<a class="prev-page" href="{{ prev.link }}"> |
| 165 |
<svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg> |
| 166 |
<div class="page-info"> |
| 167 |
<div class="context"> |
| 168 |
<span>{{ _("Previous") }}</span> |
| 169 |
</div> |
| 170 |
{% if prev.link == pathto(master_doc) %} |
| 171 |
<div class="title">{{ _("Home") }}</div> |
| 172 |
{% else %} |
| 173 |
<div class="title">{{ prev.title }}</div> |
| 174 |
{% endif %} |
| 175 |
</div> |
| 176 |
</a> |
| 177 |
{%- endif %} |
| 178 |
</div> |
| 179 |
<div class="bottom-of-page"> |
| 180 |
<div class="left-details"> |
| 181 |
{%- if show_copyright %} |
| 182 |
<div class="copyright"> |
| 183 |
{%- if hasdoc('copyright') %} |
| 184 |
{% trans path=pathto('copyright'), copyright=copyright|e -%} |
| 185 |
<a href="{{ path }}">Copyright</a> © {{ copyright }} |
| 186 |
{%- endtrans %} |
| 187 |
{%- else %} |
| 188 |
{% trans copyright=copyright|e -%} |
| 189 |
Copyright © {{ copyright }} |
| 190 |
{%- endtrans %} |
| 191 |
{%- endif %} |
| 192 |
</div> |
| 193 |
{%- endif %} |
| 194 |
{% trans %}Made with {% endtrans -%} |
| 195 |
{%- if show_sphinx -%} |
| 196 |
{% trans %}<a href="https://www.sphinx-doc.org/">Sphinx</a> and {% endtrans -%} |
| 197 |
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s |
| 198 |
{% endif -%} |
| 199 |
{% trans %} |
| 200 |
<a href="https://github.com/pradyunsg/furo">Furo</a> |
| 201 |
{% endtrans %} |
| 202 |
{%- if last_updated -%} |
| 203 |
<div class="last-updated"> |
| 204 |
{% trans last_updated=last_updated|e -%} |
| 205 |
Last updated on {{ last_updated }} |
| 206 |
{%- endtrans -%} |
| 207 |
</div> |
| 208 |
{%- endif %} |
| 209 |
{# start of AWS modification of Furo template #} |
| 210 |
<div class="legal-info"> |
| 211 |
<a href="https://aws.amazon.com/privacy">Privacy</a> | |
| 212 |
<a href="https://aws.amazon.com/terms">Site Terms</a> | |
| 213 |
<a href="#" id="cookie-button-link">Cookie preferences</a> |
| 214 |
</div> |
| 215 |
{# end of AWS modification of Furo template #} |
| 216 |
</div> |
| 217 |
<div class="right-details"> |
| 218 |
{% if theme_footer_icons or READTHEDOCS -%} |
| 219 |
<div class="icons"> |
| 220 |
{% if theme_footer_icons -%} |
| 221 |
{% for icon_dict in theme_footer_icons -%} |
| 222 |
<a class="muted-link {{ icon_dict.class }}" href="{{ icon_dict.url }}" aria-label="{{ icon_dict.name }}"> |
| 223 |
{{- icon_dict.html -}} |
| 224 |
</a> |
| 225 |
{% endfor %} |
| 226 |
{%- else -%} |
| 227 |
{#- Show Read the Docs project -#} |
| 228 |
{%- if READTHEDOCS and slug -%} |
| 229 |
<a class="muted-link" href="https://readthedocs.org/projects/{{ slug }}" aria-label="On Read the Docs"> |
| 230 |
<svg x="0px" y="0px" viewBox="-125 217 360 360" xml:space="preserve"> |
| 231 |
<path fill="currentColor" d="M39.2,391.3c-4.2,0.6-7.1,4.4-6.5,8.5c0.4,3,2.6,5.5,5.5,6.3 c0,0,18.5,6.1,50,8.7c25.3,2.1,54-1.8,54-1.8c4.2-0.1,7.5-3.6,7.4-7.8c-0.1-4.2-3.6-7.5-7.8-7.4c-0.5,0-1,0.1-1.5,0.2 c0,0-28.1,3.5-50.9,1.6c-30.1-2.4-46.5-7.9-46.5-7.9C41.7,391.3,40.4,391.1,39.2,391.3z M39.2,353.6c-4.2,0.6-7.1,4.4-6.5,8.5 c0.4,3,2.6,5.5,5.5,6.3c0,0,18.5,6.1,50,8.7c25.3,2.1,54-1.8,54-1.8c4.2-0.1,7.5-3.6,7.4-7.8c-0.1-4.2-3.6-7.5-7.8-7.4 c-0.5,0-1,0.1-1.5,0.2c0,0-28.1,3.5-50.9,1.6c-30.1-2.4-46.5-7.9-46.5-7.9C41.7,353.6,40.4,353.4,39.2,353.6z M39.2,315.9 c-4.2,0.6-7.1,4.4-6.5,8.5c0.4,3,2.6,5.5,5.5,6.3c0,0,18.5,6.1,50,8.7c25.3,2.1,54-1.8,54-1.8c4.2-0.1,7.5-3.6,7.4-7.8 c-0.1-4.2-3.6-7.5-7.8-7.4c-0.5,0-1,0.1-1.5,0.2c0,0-28.1,3.5-50.9,1.6c-30.1-2.4-46.5-7.9-46.5-7.9 C41.7,315.9,40.4,315.8,39.2,315.9z M39.2,278.3c-4.2,0.6-7.1,4.4-6.5,8.5c0.4,3,2.6,5.5,5.5,6.3c0,0,18.5,6.1,50,8.7 c25.3,2.1,54-1.8,54-1.8c4.2-0.1,7.5-3.6,7.4-7.8c-0.1-4.2-3.6-7.5-7.8-7.4c-0.5,0-1,0.1-1.5,0.2c0,0-28.1,3.5-50.9,1.6 c-30.1-2.4-46.5-7.9-46.5-7.9C41.7,278.2,40.4,278.1,39.2,278.3z M-13.6,238.5c-39.6,0.3-54.3,12.5-54.3,12.5v295.7 c0,0,14.4-12.4,60.8-10.5s55.9,18.2,112.9,19.3s71.3-8.8,71.3-8.8l0.8-301.4c0,0-25.6,7.3-75.6,7.7c-49.9,0.4-61.9-12.7-107.7-14.2 C-8.2,238.6-10.9,238.5-13.6,238.5z M19.5,257.8c0,0,24,7.9,68.3,10.1c37.5,1.9,75-3.7,75-3.7v267.9c0,0-19,10-66.5,6.6 C59.5,536.1,19,522.1,19,522.1L19.5,257.8z M-3.6,264.8c4.2,0,7.7,3.4,7.7,7.7c0,4.2-3.4,7.7-7.7,7.7c0,0-12.4,0.1-20,0.8 c-12.7,1.3-21.4,5.9-21.4,5.9c-3.7,2-8.4,0.5-10.3-3.2c-2-3.7-0.5-8.4,3.2-10.3c0,0,0,0,0,0c0,0,11.3-6,27-7.5 C-16,264.9-3.6,264.8-3.6,264.8z M-11,302.6c4.2-0.1,7.4,0,7.4,0c4.2,0.5,7.2,4.3,6.7,8.5c-0.4,3.5-3.2,6.3-6.7,6.7 c0,0-12.4,0.1-20,0.8c-12.7,1.3-21.4,5.9-21.4,5.9c-3.7,2-8.4,0.5-10.3-3.2c-2-3.7-0.5-8.4,3.2-10.3c0,0,11.3-6,27-7.5 C-20.5,302.9-15.2,302.7-11,302.6z M-3.6,340.2c4.2,0,7.7,3.4,7.7,7.7s-3.4,7.7-7.7,7.7c0,0-12.4-0.1-20,0.7 c-12.7,1.3-21.4,5.9-21.4,5.9c-3.7,2-8.4,0.5-10.3-3.2c-2-3.7-0.5-8.4,3.2-10.3c0,0,11.3-6,27-7.5C-16,340.1-3.6,340.2-3.6,340.2z" /> |
| 232 |
</svg> |
| 233 |
</a> |
| 234 |
{%- endif -%} |
| 235 |
{#- Show GitHub repository home -#} |
| 236 |
{%- if READTHEDOCS and display_github and github_user != "None" and github_repo != "None" -%} |
| 237 |
<a class="muted-link" href="https://github.com/{{ github_user }}/{{ github_repo }}" aria-label="On GitHub"> |
| 238 |
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16"> |
| 239 |
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path> |
| 240 |
</svg> |
| 241 |
</a> |
| 242 |
{%- endif -%} |
| 243 |
{%- endif %} |
| 244 |
</div> |
| 245 |
{%- endif %} |
| 246 |
</div> |
| 247 |
</div> |
| 248 |
{% endblock footer %} |
| 249 |
</footer> |
| 250 |
</div> |
| 251 |
<aside class="toc-drawer{% if furo_hide_toc %} no-toc{% endif %}"> |
| 252 |
{% block right_sidebar %} |
| 253 |
{% if not furo_hide_toc %} |
| 254 |
<div class="toc-sticky toc-scroll"> |
| 255 |
<div class="sidebar-div show-div-md justify-content-left"> |
| 256 |
<label class="nav-close-icon" id="toc-menu-close" for="__toc" tabindex="0"> |
| 257 |
<div class="visually-hidden">Toggle site table of content right sidebar</div> |
| 258 |
<i class="icon"><svg><use href="#svg-close"></use></svg></i> |
| 259 |
</label> |
| 260 |
</div> |
| 261 |
<div class="toc-title-container"> |
| 262 |
<span class="toc-title"> |
| 263 |
{{ _("On this page") }} |
| 264 |
</span> |
| 265 |
</div> |
| 266 |
<div class="toc-tree-container"> |
| 267 |
<div class="toc-tree"> |
| 268 |
{{ toc }} |
| 269 |
</div> |
| 270 |
</div> |
| 271 |
</div> |
| 272 |
{% endif %} |
| 273 |
{% endblock right_sidebar %} |
| 274 |
</aside> |
| 275 |
</div> |
| 276 |
</div> |
| 277 |
{%- endblock %} |