|
0
|
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 |
|
|
|
11 |
<!DOCTYPE html>
|
|
|
12 |
<!--[if IE 8]><html class="no-js lt-ie9" lang="{{ lang_attr }}" > <![endif]-->
|
|
|
13 |
<!--[if gt IE 8]><!--> <html class="no-js" lang="{{ lang_attr }}" > <!--<![endif]-->
|
|
|
14 |
<head>
|
|
|
15 |
<meta charset="utf-8">
|
|
|
16 |
{{ metatags }}
|
|
|
17 |
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
18 |
{% block htmltitle %}
|
|
|
19 |
<title>{{ title|striptags|e }}{{ titlesuffix }}</title>
|
|
|
20 |
{% endblock %}
|
|
|
21 |
|
|
|
22 |
{# FAVICON #}
|
|
|
23 |
{% if favicon %}
|
|
|
24 |
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
|
|
|
25 |
{% endif %}
|
|
|
26 |
{# CANONICAL URL #}
|
|
|
27 |
{% if theme_canonical_url %}
|
|
|
28 |
<link rel="canonical" href="{{ theme_canonical_url }}{{ pagename }}.html"/>
|
|
|
29 |
{% endif %}
|
|
|
30 |
|
|
|
31 |
{# CSS #}
|
|
|
32 |
|
|
|
33 |
{# OPENSEARCH #}
|
|
|
34 |
{% if not embedded %}
|
|
|
35 |
{% if use_opensearch %}
|
|
|
36 |
<link rel="search" type="application/opensearchdescription+xml" title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" href="{{ pathto('_static/opensearch.xml', 1) }}"/>
|
|
|
37 |
{% endif %}
|
|
|
38 |
|
|
|
39 |
{% endif %}
|
|
|
40 |
|
|
|
41 |
{# RTD hosts this file, so just load on non RTD builds #}
|
|
|
42 |
{% if not READTHEDOCS %}
|
|
|
43 |
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
|
|
|
44 |
{% endif %}
|
|
|
45 |
|
|
|
46 |
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
|
|
|
47 |
|
|
|
48 |
{% for cssfile in css_files %}
|
|
|
49 |
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
|
|
|
50 |
{% endfor %}
|
|
|
51 |
|
|
|
52 |
{% for cssfile in extra_css_files %}
|
|
|
53 |
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
|
|
|
54 |
{% endfor %}
|
|
|
55 |
|
|
|
56 |
{%- block linktags %}
|
|
|
57 |
{%- if hasdoc('about') %}
|
|
|
58 |
<link rel="author" title="{{ _('About these documents') }}"
|
|
|
59 |
href="{{ pathto('about') }}"/>
|
|
|
60 |
{%- endif %}
|
|
|
61 |
{%- if hasdoc('genindex') %}
|
|
|
62 |
<link rel="index" title="{{ _('Index') }}"
|
|
|
63 |
href="{{ pathto('genindex') }}"/>
|
|
|
64 |
{%- endif %}
|
|
|
65 |
{%- if hasdoc('search') %}
|
|
|
66 |
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}"/>
|
|
|
67 |
{%- endif %}
|
|
|
68 |
{%- if hasdoc('copyright') %}
|
|
|
69 |
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}"/>
|
|
|
70 |
{%- endif %}
|
|
|
71 |
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}"/>
|
|
|
72 |
{%- if parents %}
|
|
|
73 |
<link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}"/>
|
|
|
74 |
{%- endif %}
|
|
|
75 |
{%- if next %}
|
|
|
76 |
<link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}"/>
|
|
|
77 |
{%- endif %}
|
|
|
78 |
{%- if prev %}
|
|
|
79 |
<link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}"/>
|
|
|
80 |
{%- endif %}
|
|
|
81 |
{%- endblock %}
|
|
|
82 |
{%- block extrahead %} {% endblock %}
|
|
|
83 |
|
|
|
84 |
{# Keep modernizr in head - http://modernizr.com/docs/#installing #}
|
|
|
85 |
<script src="{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
|
|
|
86 |
|
|
|
87 |
</head>
|
|
|
88 |
|
|
|
89 |
<body class="wy-body-for-nav" role="document">
|
|
|
90 |
|
|
|
91 |
{% block extrabody %} {% endblock %}
|
|
|
92 |
<div class="wy-grid-for-nav">
|
|
|
93 |
|
|
|
94 |
{# SIDE NAV, TOGGLES ON MOBILE #}
|
|
|
95 |
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
|
96 |
<div class="wy-side-scroll">
|
|
|
97 |
<div class="wy-side-nav-search">
|
|
|
98 |
{% block sidebartitle %}
|
|
|
99 |
|
|
|
100 |
{% if logo and theme_logo_only %}
|
|
|
101 |
<a href="{{ pathto(master_doc) }}">
|
|
|
102 |
{% else %}
|
|
|
103 |
<a href="{{ pathto(master_doc) }}" class="icon icon-home"> {{ project }}
|
|
|
104 |
{% endif %}
|
|
|
105 |
|
|
|
106 |
{% if logo %}
|
|
|
107 |
{# Not strictly valid HTML, but it's the only way to display/scale it properly, without weird scripting or heaps of work #}
|
|
|
108 |
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" />
|
|
|
109 |
{% endif %}
|
|
|
110 |
</a>
|
|
|
111 |
|
|
|
112 |
{% if theme_display_version %}
|
|
|
113 |
{%- set nav_version = version %}
|
|
|
114 |
{% if READTHEDOCS and current_version %}
|
|
|
115 |
{%- set nav_version = current_version %}
|
|
|
116 |
{% endif %}
|
|
|
117 |
{% if nav_version %}
|
|
|
118 |
<div class="version">
|
|
|
119 |
{{ nav_version }}
|
|
|
120 |
</div>
|
|
|
121 |
{% endif %}
|
|
|
122 |
{% endif %}
|
|
|
123 |
|
|
|
124 |
{% include "searchbox.html" %}
|
|
|
125 |
|
|
|
126 |
{% endblock %}
|
|
|
127 |
</div>
|
|
|
128 |
|
|
|
129 |
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
|
130 |
{% block menu %}
|
|
|
131 |
{#
|
|
|
132 |
The singlehtml builder doesn't handle this toctree call when the
|
|
|
133 |
toctree is empty. Skip building this for now.
|
|
|
134 |
#}
|
|
|
135 |
{% if 'singlehtml' not in builder %}
|
|
|
136 |
{% set global_toc = toctree(maxdepth=theme_navigation_depth|int,
|
|
|
137 |
collapse=theme_collapse_navigation|tobool,
|
|
|
138 |
includehidden=theme_includehidden|tobool,
|
|
|
139 |
titles_only=theme_titles_only|tobool) %}
|
|
|
140 |
{% endif %}
|
|
|
141 |
{% if global_toc %}
|
|
|
142 |
{{ global_toc }}
|
|
|
143 |
{% else %}
|
|
|
144 |
<!-- Local TOC -->
|
|
|
145 |
<div class="local-toc">{{ toc }}</div>
|
|
|
146 |
{% endif %}
|
|
|
147 |
{% endblock %}
|
|
|
148 |
</div>
|
|
|
149 |
</div>
|
|
|
150 |
</nav>
|
|
|
151 |
|
|
|
152 |
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
153 |
|
|
|
154 |
{# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
|
|
|
155 |
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
|
156 |
{% block mobile_nav %}
|
|
|
157 |
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
|
158 |
<a href="{{ pathto(master_doc) }}">{{ project }}</a>
|
|
|
159 |
{% endblock %}
|
|
|
160 |
</nav>
|
|
|
161 |
|
|
|
162 |
|
|
|
163 |
{# PAGE CONTENT #}
|
|
|
164 |
<div class="wy-nav-content">
|
|
|
165 |
{% if theme_style_external_links|tobool %}
|
|
|
166 |
<div class="rst-content style-external-links">
|
|
|
167 |
{% else %}
|
|
|
168 |
<div class="rst-content">
|
|
|
169 |
{% endif %}
|
|
|
170 |
{% include "breadcrumbs.html" %}
|
|
|
171 |
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
|
172 |
<div itemprop="articleBody">
|
|
|
173 |
{% block body %}{% endblock %}
|
|
|
174 |
</div>
|
|
|
175 |
<div class="articleComments">
|
|
|
176 |
{% block comments %}{% endblock %}
|
|
|
177 |
</div>
|
|
|
178 |
</div>
|
|
|
179 |
{% include "footer.html" %}
|
|
|
180 |
</div>
|
|
|
181 |
</div>
|
|
|
182 |
|
|
|
183 |
</section>
|
|
|
184 |
|
|
|
185 |
</div>
|
|
|
186 |
{% include "versions.html" %}
|
|
|
187 |
|
|
|
188 |
{% if not embedded %}
|
|
|
189 |
|
|
|
190 |
<script type="text/javascript">
|
|
|
191 |
var DOCUMENTATION_OPTIONS = {
|
|
|
192 |
URL_ROOT:'{{ url_root }}',
|
|
|
193 |
VERSION:'{{ release|e }}',
|
|
|
194 |
LANGUAGE:'{{ language }}',
|
|
|
195 |
COLLAPSE_INDEX:false,
|
|
|
196 |
FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
|
|
|
197 |
HAS_SOURCE: {{ has_source|lower }},
|
|
|
198 |
SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
|
|
|
199 |
};
|
|
|
200 |
</script>
|
|
|
201 |
{%- for scriptfile in script_files %}
|
|
|
202 |
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
|
|
|
203 |
{%- endfor %}
|
|
|
204 |
|
|
|
205 |
{% endif %}
|
|
|
206 |
|
|
|
207 |
{# RTD hosts this file, so just load on non RTD builds #}
|
|
|
208 |
{% if not READTHEDOCS %}
|
|
|
209 |
<script type="text/javascript" src="{{ pathto('_static/js/theme.js', 1) }}"></script>
|
|
|
210 |
{% endif %}
|
|
|
211 |
|
|
|
212 |
<script type="text/javascript">
|
|
|
213 |
jQuery(function () {
|
|
|
214 |
{% if theme_sticky_navigation|tobool %}
|
|
|
215 |
SphinxRtdTheme.Navigation.enableSticky();
|
|
|
216 |
{% else %}
|
|
|
217 |
SphinxRtdTheme.Navigation.enable();
|
|
|
218 |
{% endif %}
|
|
|
219 |
});
|
|
|
220 |
</script>
|
|
|
221 |
|
|
|
222 |
{%- block footer %} {% endblock %}
|
|
|
223 |
|
|
|
224 |
</body>
|
|
|
225 |
</html>
|