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