| 1 |
{# TEMPLATE VAR SETTINGS #} |
| 2 |
{%- set url_root = pathto('', 1) %} |
| 3 |
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} |
| 4 |
{%- if not embedded and docstitle %} |
| 5 |
{%- set titlesuffix = " — "|safe + docstitle|e %} |
| 6 |
{%- else %} |
| 7 |
{%- set titlesuffix = "" %} |
| 8 |
{%- endif %} |
| 9 |
{%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %} |
| 10 |
{%- set sphinx_writer = 'writer-html5' if html5_doctype else 'writer-html4' -%} |
| 11 |
|
| 12 |
{# Build sphinx_version_info tuple from sphinx_version string in pure Jinja #} |
| 13 |
{%- set (_ver_major, _ver_minor) = (sphinx_version.split('.') | list)[:2] | map('int') -%} |
| 14 |
{%- set sphinx_version_info = (_ver_major, _ver_minor, -1) -%} |
| 15 |
|
| 16 |
<!DOCTYPE html> |
| 17 |
<html class="{{ sphinx_writer }}" lang="{{ lang_attr }}" > |
| 18 |
<head> |
| 19 |
<meta charset="utf-8" /> |
| 20 |
{{- metatags }} |
| 21 |
<meta name="viewport" content="width=device-width, initial-scale=1.0" /> |
| 22 |
{%- block htmltitle %} |
| 23 |
<title>{{ title|striptags|e }}{{ titlesuffix }}</title> |
| 24 |
{%- endblock -%} |
| 25 |
|
| 26 |
{#- CSS #} |
| 27 |
{%- if sphinx_version_info < (4, 0) -%} |
| 28 |
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" /> |
| 29 |
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" /> |
| 30 |
{%- endif %} |
| 31 |
{%- for css in css_files %} |
| 32 |
{%- if css|attr("rel") %} |
| 33 |
<link rel="{{ css.rel }}" href="{{ pathto(css.filename, 1) }}" type="text/css"{% if css.title is not none %} title="{{ css.title }}"{% endif %} /> |
| 34 |
{%- else %} |
| 35 |
<link rel="stylesheet" href="{{ pathto(css, 1) }}" type="text/css" /> |
| 36 |
{%- endif %} |
| 37 |
{%- endfor %} |
| 38 |
|
| 39 |
{%- for cssfile in extra_css_files %} |
| 40 |
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" /> |
| 41 |
{%- endfor -%} |
| 42 |
|
| 43 |
{#- FAVICON |
| 44 |
favicon_url is the only context var necessary since Sphinx 4. |
| 45 |
In Sphinx<4, we use favicon but need to prepend path info. |
| 46 |
#} |
| 47 |
{%- set _favicon_url = favicon_url | default(pathto('_static/' + (favicon or ""), 1)) %} |
| 48 |
{%- if favicon_url or favicon %} |
| 49 |
<link rel="shortcut icon" href="{{ _favicon_url }}"/> |
| 50 |
{%- endif %} |
| 51 |
|
| 52 |
{#- CANONICAL URL (deprecated) #} |
| 53 |
{%- if theme_canonical_url and not pageurl %} |
| 54 |
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/> |
| 55 |
{%- endif -%} |
| 56 |
|
| 57 |
{#- CANONICAL URL #} |
| 58 |
{%- if pageurl %} |
| 59 |
<link rel="canonical" href="{{ pageurl|e }}" /> |
| 60 |
{%- endif -%} |
| 61 |
|
| 62 |
{#- JAVASCRIPTS #} |
| 63 |
{%- block scripts %} |
| 64 |
<!--[if lt IE 9]> |
| 65 |
<script src="{{ pathto('_static/js/html5shiv.min.js', 1) }}"></script> |
| 66 |
<![endif]--> |
| 67 |
{%- if not embedded %} |
| 68 |
{# XXX Sphinx 1.8.0 made this an external js-file, quick fix until we refactor the template to inherert more blocks directly from sphinx #} |
| 69 |
{%- if sphinx_version_info >= (1, 8) -%} |
| 70 |
{%- if sphinx_version_info < (4, 0) -%} |
| 71 |
<script id="documentation_options" data-url_root="{{ url_root }}" src="{{ pathto('_static/documentation_options.js', 1) }}"></script> |
| 72 |
{%- endif -%} |
| 73 |
{%- for scriptfile in script_files %} |
| 74 |
{{ js_tag(scriptfile) }} |
| 75 |
{%- endfor %} |
| 76 |
{%- else %} |
| 77 |
<script> |
| 78 |
var DOCUMENTATION_OPTIONS = { |
| 79 |
URL_ROOT:'{{ url_root }}', |
| 80 |
VERSION:'{{ release|e }}', |
| 81 |
LANGUAGE:'{{ language }}', |
| 82 |
COLLAPSE_INDEX:false, |
| 83 |
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}', |
| 84 |
HAS_SOURCE: {{ has_source|lower }}, |
| 85 |
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}' |
| 86 |
}; |
| 87 |
</script> |
| 88 |
{%- for scriptfile in script_files %} |
| 89 |
<script src="{{ pathto(scriptfile, 1) }}"></script> |
| 90 |
{%- endfor %} |
| 91 |
{%- endif %} |
| 92 |
<script src="{{ pathto('_static/js/theme.js', 1) }}"></script> |
| 93 |
|
| 94 |
{#- OPENSEARCH #} |
| 95 |
{%- if use_opensearch %} |
| 96 |
<link rel="search" type="application/opensearchdescription+xml" |
| 97 |
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" |
| 98 |
href="{{ pathto('_static/opensearch.xml', 1) }}"/> |
| 99 |
{%- endif %} |
| 100 |
{%- endif %} |
| 101 |
{%- endblock %} |
| 102 |
|
| 103 |
{%- block linktags %} |
| 104 |
{%- if hasdoc('about') %} |
| 105 |
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" /> |
| 106 |
{%- endif %} |
| 107 |
{%- if hasdoc('genindex') %} |
| 108 |
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" /> |
| 109 |
{%- endif %} |
| 110 |
{%- if hasdoc('search') %} |
| 111 |
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" /> |
| 112 |
{%- endif %} |
| 113 |
{%- if hasdoc('copyright') %} |
| 114 |
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" /> |
| 115 |
{%- endif %} |
| 116 |
{%- if next %} |
| 117 |
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" /> |
| 118 |
{%- endif %} |
| 119 |
{%- if prev %} |
| 120 |
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" /> |
| 121 |
{%- endif %} |
| 122 |
{%- endblock %} |
| 123 |
{%- block extrahead %} {% endblock %} |
| 124 |
</head> |
| 125 |
|
| 126 |
<body class="wy-body-for-nav"> |
| 127 |
|
| 128 |
{%- block extrabody %} {% endblock %} |
| 129 |
<div class="wy-grid-for-nav"> |
| 130 |
{#- SIDE NAV, TOGGLES ON MOBILE #} |
| 131 |
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> |
| 132 |
<div class="wy-side-scroll"> |
| 133 |
<div class="wy-side-nav-search" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}> |
| 134 |
{%- block sidebartitle %} |
| 135 |
|
| 136 |
{# the logo helper function was removed in Sphinx 6 and deprecated since Sphinx 4 #} |
| 137 |
{# the master_doc variable was renamed to root_doc in Sphinx 4 (master_doc still exists in later Sphinx versions) #} |
| 138 |
{%- set _logo_url = logo_url|default(pathto('_static/' + (logo or ""), 1)) %} |
| 139 |
{%- set _root_doc = root_doc|default(master_doc) %} |
| 140 |
<a href="{{ pathto(_root_doc) }}"{% if not theme_logo_only %} class="icon icon-home"{% endif %}> |
| 141 |
{% if not theme_logo_only %}{{ project }}{% endif %} |
| 142 |
{%- if logo or logo_url %} |
| 143 |
<img src="{{ _logo_url }}" class="logo" alt="{{ _('Logo') }}"/> |
| 144 |
{%- endif %} |
| 145 |
</a> |
| 146 |
|
| 147 |
{%- if theme_display_version %} |
| 148 |
{%- set nav_version = version %} |
| 149 |
{%- if READTHEDOCS and current_version %} |
| 150 |
{%- set nav_version = current_version %} |
| 151 |
{%- endif %} |
| 152 |
{%- if nav_version %} |
| 153 |
<div class="version"> |
| 154 |
{{ nav_version }} |
| 155 |
</div> |
| 156 |
{%- endif %} |
| 157 |
{%- endif %} |
| 158 |
|
| 159 |
{%- include "searchbox.html" %} |
| 160 |
|
| 161 |
{%- endblock %} |
| 162 |
</div> |
| 163 |
|
| 164 |
{%- block navigation %} |
| 165 |
{#- Translators: This is an ARIA section label for the main navigation menu -#} |
| 166 |
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="{{ _('Navigation menu') }}"> |
| 167 |
{%- block menu %} |
| 168 |
{%- set toctree = toctree(maxdepth=theme_navigation_depth|int, |
| 169 |
collapse=theme_collapse_navigation|tobool, |
| 170 |
includehidden=theme_includehidden|tobool, |
| 171 |
titles_only=theme_titles_only|tobool) %} |
| 172 |
{%- if toctree %} |
| 173 |
{{ toctree }} |
| 174 |
{%- else %} |
| 175 |
<!-- Local TOC --> |
| 176 |
<div class="local-toc">{{ toc }}</div> |
| 177 |
{%- endif %} |
| 178 |
{%- endblock %} |
| 179 |
</div> |
| 180 |
{%- endblock %} |
| 181 |
</div> |
| 182 |
</nav> |
| 183 |
|
| 184 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> |
| 185 |
|
| 186 |
{#- MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #} |
| 187 |
{#- Translators: This is an ARIA section label for the navigation menu that is visible when viewing the page on mobile devices -#} |
| 188 |
<nav class="wy-nav-top" aria-label="{{ _('Mobile navigation menu') }}" {% if theme_style_nav_header_background %} style="background: {{theme_style_nav_header_background}}" {% endif %}> |
| 189 |
{%- block mobile_nav %} |
| 190 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> |
| 191 |
<a href="{{ pathto(master_doc) }}">{{ project }}</a> |
| 192 |
{%- endblock %} |
| 193 |
</nav> |
| 194 |
|
| 195 |
<div class="wy-nav-content"> |
| 196 |
{%- block content %} |
| 197 |
{%- if theme_style_external_links|tobool %} |
| 198 |
<div class="rst-content style-external-links"> |
| 199 |
{%- else %} |
| 200 |
<div class="rst-content"> |
| 201 |
{%- endif %} |
| 202 |
{% include "breadcrumbs.html" %} |
| 203 |
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> |
| 204 |
{%- block document %} |
| 205 |
<div itemprop="articleBody"> |
| 206 |
{% block body %}{% endblock %} |
| 207 |
</div> |
| 208 |
{%- if self.comments()|trim %} |
| 209 |
<div class="articleComments"> |
| 210 |
{%- block comments %}{% endblock %} |
| 211 |
</div> |
| 212 |
{%- endif%} |
| 213 |
</div> |
| 214 |
{%- endblock %} |
| 215 |
{% include "footer.html" %} |
| 216 |
</div> |
| 217 |
{%- endblock %} |
| 218 |
</div> |
| 219 |
</section> |
| 220 |
</div> |
| 221 |
{% include "versions.html" -%} |
| 222 |
|
| 223 |
<script> |
| 224 |
jQuery(function () { |
| 225 |
SphinxRtdTheme.Navigation.enable({{ 'true' if theme_sticky_navigation|tobool else 'false' }}); |
| 226 |
}); |
| 227 |
</script> |
| 228 |
|
| 229 |
{#- Do not conflict with RTD insertion of analytics script #} |
| 230 |
{%- if not READTHEDOCS %} |
| 231 |
{%- if theme_analytics_id %} |
| 232 |
<!-- Theme Analytics --> |
| 233 |
<script async src="https://www.googletagmanager.com/gtag/js?id={{ theme_analytics_id }}"></script> |
| 234 |
<script> |
| 235 |
window.dataLayer = window.dataLayer || []; |
| 236 |
function gtag(){dataLayer.push(arguments);} |
| 237 |
gtag('js', new Date()); |
| 238 |
|
| 239 |
gtag('config', '{{ theme_analytics_id }}', { |
| 240 |
'anonymize_ip': {{ 'true' if theme_analytics_anonymize_ip|tobool else 'false' }}, |
| 241 |
}); |
| 242 |
</script> |
| 243 |
|
| 244 |
{%- endif %} |
| 245 |
{%- endif %} |
| 246 |
|
| 247 |
{%- block footer %} {% endblock %} |
| 248 |
|
| 249 |
</body> |
| 250 |
</html> |