page.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207
  1. {% extends "base.html" %}
  2. {% block body -%}
  3. {{ super() }}
  4. {% include "partials/icons.html" %}
  5. <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
  6. <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
  7. <label class="overlay sidebar-overlay" for="__navigation">
  8. <div class="visually-hidden">Hide navigation sidebar</div>
  9. </label>
  10. <label class="overlay toc-overlay" for="__toc">
  11. <div class="visually-hidden">Hide table of contents sidebar</div>
  12. </label>
  13. {% if theme_announcement -%}
  14. <div class="announcement">
  15. <aside class="announcement-content">
  16. {% block announcement %} {{ theme_announcement }} {% endblock announcement %}
  17. </aside>
  18. </div>
  19. {%- endif %}
  20. <div class="page">
  21. <header class="mobile-header">
  22. <div class="header-left">
  23. <label class="nav-overlay-icon" for="__navigation">
  24. <div class="visually-hidden">Toggle site navigation sidebar</div>
  25. <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
  26. </label>
  27. </div>
  28. <div class="header-center">
  29. <a href="{{ pathto(master_doc) }}"><div class="brand">{{ docstitle if docstitle else project }}</div></a>
  30. </div>
  31. <div class="header-right">
  32. <div class="theme-toggle-container theme-toggle-header">
  33. <button class="theme-toggle">
  34. <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
  35. <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
  36. <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
  37. <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
  38. </button>
  39. </div>
  40. <label class="toc-overlay-icon toc-header-icon{% if furo_hide_toc %} no-toc{% endif %}" for="__toc">
  41. <div class="visually-hidden">Toggle table of contents sidebar</div>
  42. <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
  43. </label>
  44. </div>
  45. </header>
  46. <aside class="sidebar-drawer">
  47. <div class="sidebar-container">
  48. {% block left_sidebar %}
  49. <div class="sidebar-sticky">
  50. {%- for sidebar_section in sidebars %}
  51. {%- include sidebar_section %}
  52. {%- endfor %}
  53. </div>
  54. {% endblock left_sidebar %}
  55. </div>
  56. </aside>
  57. <div class="main">
  58. <div class="content">
  59. <div class="article-container">
  60. <a href="#" class="back-to-top muted-link">
  61. <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
  62. <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
  63. </svg>
  64. <span>{% trans %}Back to top{% endtrans %}</span>
  65. </a>
  66. <div class="content-icon-container">
  67. {% if theme_top_of_page_button == "edit" -%}
  68. {%- include "components/edit-this-page.html" with context -%}
  69. {%- elif theme_top_of_page_button != None -%}
  70. {{ warning("Got an unsupported value for 'top_of_page_button'") }}
  71. {%- endif -%}
  72. {#- Theme toggle -#}
  73. <div class="theme-toggle-container theme-toggle-content">
  74. <button class="theme-toggle">
  75. <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
  76. <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
  77. <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
  78. <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
  79. </button>
  80. </div>
  81. <label class="toc-overlay-icon toc-content-icon{% if furo_hide_toc %} no-toc{% endif %}" for="__toc">
  82. <div class="visually-hidden">Toggle table of contents sidebar</div>
  83. <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
  84. </label>
  85. </div>
  86. <article role="main">
  87. {% block content %}{{ body }}{% endblock %}
  88. </article>
  89. </div>
  90. <footer>
  91. {% block footer %}
  92. <div class="related-pages">
  93. {% if next and not meta.get("lastpage") -%}
  94. <a class="next-page" href="{{ next.link }}">
  95. <div class="page-info">
  96. <div class="context">
  97. <span>{{ _("Next") }}</span>
  98. </div>
  99. <div class="title">{{ next.title }}</div>
  100. </div>
  101. <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
  102. </a>
  103. {%- endif %}
  104. {% if next and not meta.get("firstpage") -%}
  105. <a class="prev-page" href="{{ prev.link }}">
  106. <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
  107. <div class="page-info">
  108. <div class="context">
  109. <span>{{ _("Previous") }}</span>
  110. </div>
  111. {% if prev.link == pathto(master_doc) %}
  112. <div class="title">{{ _("Home") }}</div>
  113. {% else %}
  114. <div class="title">{{ prev.title }}</div>
  115. {% endif %}
  116. </div>
  117. </a>
  118. {%- endif %}
  119. </div>
  120. <div class="bottom-of-page">
  121. <div class="left-details">
  122. {%- if show_copyright %}
  123. <div class="copyright">
  124. {%- if hasdoc('copyright') %}
  125. {% trans path=pathto('copyright'), copyright=copyright|e -%}
  126. <a href="{{ path }}">Copyright</a> &#169; {{ copyright }}
  127. {%- endtrans %}
  128. {%- else %}
  129. {% trans copyright=copyright|e -%}
  130. Copyright &#169; {{ copyright }}
  131. {%- endtrans %}
  132. {%- endif %}
  133. </div>
  134. {%- endif %}
  135. {% trans %}Made with {% endtrans -%}
  136. {%- if show_sphinx -%}
  137. {% trans %}<a href="https://www.sphinx-doc.org/">Sphinx</a> and {% endtrans -%}
  138. <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
  139. {% endif -%}
  140. {% trans %}
  141. <a href="https://github.com/pradyunsg/furo">Furo</a>
  142. {% endtrans %}
  143. {%- if last_updated -%}
  144. <div class="last-updated">
  145. {% trans last_updated=last_updated|e -%}
  146. Last updated on {{ last_updated }}
  147. {%- endtrans -%}
  148. </div>
  149. {%- endif %}
  150. </div>
  151. <div class="right-details">
  152. <div class="icons">
  153. {% if theme_footer_icons -%}
  154. {% for icon_dict in theme_footer_icons -%}
  155. <a class="muted-link {{ icon_dict.class }}" href="{{ icon_dict.url }}" aria-label="{{ icon_dict.name }}">
  156. {{- icon_dict.html -}}
  157. </a>
  158. {% endfor %}
  159. {%- else -%}
  160. {#- Show Read the Docs project -#}
  161. {%- if READTHEDOCS and slug -%}
  162. <a class="muted-link" href="https://readthedocs.org/projects/{{ slug }}" aria-label="On Read the Docs">
  163. <svg x="0px" y="0px" viewBox="-125 217 360 360" xml:space="preserve">
  164. <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" />
  165. </svg>
  166. </a>
  167. {%- endif -%}
  168. {#- Show GitHub repository home -#}
  169. {%- if READTHEDOCS and display_github and github_user != "None" and github_repo != "None" -%}
  170. <a class="muted-link" href="https://github.com/{{ github_user }}/{{ github_repo }}" aria-label="On GitHub">
  171. <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
  172. <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>
  173. </svg>
  174. </a>
  175. {%- endif -%}
  176. {%- endif %}
  177. </div>
  178. </div>
  179. </div>
  180. {% endblock footer %}
  181. </footer>
  182. </div>
  183. <aside class="toc-drawer{% if furo_hide_toc %} no-toc{% endif %}">
  184. {% block right_sidebar %}
  185. {% if not furo_hide_toc %}
  186. <div class="toc-sticky toc-scroll">
  187. <div class="toc-title-container">
  188. <span class="toc-title">
  189. {{ _("On this page") }}
  190. </span>
  191. </div>
  192. <div class="toc-tree-container">
  193. <div class="toc-tree">
  194. {{ toc }}
  195. </div>
  196. </div>
  197. </div>
  198. {% endif %}
  199. {% endblock right_sidebar %}
  200. </aside>
  201. </div>
  202. </div>
  203. {%- endblock %}