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 %}
7 {%- set titlesuffix =
"" %}
9 {%- set lang_attr = 'en' if language == None else (language | replace('_', '-')) %}
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]-->
15 <meta charset=
"utf-8">
17 <meta name=
"viewport" content=
"width=device-width, initial-scale=1.0">
19 <title>{{ title|striptags|e }}{{ titlesuffix }}
</title>
24 <link rel=
"shortcut icon" href=
"{{ pathto('_static/' + favicon, 1) }}"/>
27 {% if theme_canonical_url %}
28 <link rel=
"canonical" href=
"{{ theme_canonical_url }}{{ pagename }}.html"/>
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) }}"/>
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" />
46 {% for cssfile in css_files %}
47 <link rel=
"stylesheet" href=
"{{ pathto(cssfile, 1) }}" type=
"text/css" />
50 {% for cssfile in extra_css_files %}
51 <link rel=
"stylesheet" href=
"{{ pathto(cssfile, 1) }}" type=
"text/css" />
55 {%- if hasdoc('about') %}
56 <link rel=
"author" title=
"{{ _('About these documents') }}"
57 href=
"{{ pathto('about') }}"/>
59 {%- if hasdoc('genindex') %}
60 <link rel=
"index" title=
"{{ _('Index') }}"
61 href=
"{{ pathto('genindex') }}"/>
63 {%- if hasdoc('search') %}
64 <link rel=
"search" title=
"{{ _('Search') }}" href=
"{{ pathto('search') }}"/>
66 {%- if hasdoc('copyright') %}
67 <link rel=
"copyright" title=
"{{ _('Copyright') }}" href=
"{{ pathto('copyright') }}"/>
69 <link rel=
"top" title=
"{{ docstitle|e }}" href=
"{{ pathto('index') }}"/>
71 <link rel=
"up" title=
"{{ parents[-1].title|striptags|e }}" href=
"{{ parents[-1].link|e }}"/>
74 <link rel=
"next" title=
"{{ next.title|striptags|e }}" href=
"{{ next.link|e }}"/>
77 <link rel=
"prev" title=
"{{ prev.title|striptags|e }}" href=
"{{ prev.link|e }}"/>
80 {%- block extrahead %} {% endblock %}
82 {# Keep modernizr in head - http://modernizr.com/docs/#installing #}
83 <script src=
"{{ pathto('_static/js/modernizr.min.js', 1) }}"></script>
87 <body class=
"wy-body-for-nav" role=
"document">
89 {% block extrabody %} {% endblock %}
90 <div class=
"wy-grid-for-nav">
92 {# SIDE NAV, TOGGLES ON MOBILE #}
93 <nav data-toggle=
"wy-nav-shift" class=
"wy-nav-side">
94 <div class=
"wy-side-scroll">
95 <div class=
"wy-side-nav-search">
96 {% block sidebartitle %}
98 {% if logo and theme_logo_only %}
99 <a href=
"{{ pathto(master_doc) }}">
101 <a href=
"{{ pathto(master_doc) }}" class=
"icon icon-home"> {{ project }}
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" />
110 {% if theme_display_version %}
111 {%- set nav_version = version %}
112 {% if READTHEDOCS and current_version %}
113 {%- set nav_version = current_version %}
116 <div class=
"version">
122 {% include
"searchbox.html" %}
127 <div class=
"wy-menu wy-menu-vertical" data-spy=
"affix" role=
"navigation" aria-label=
"main navigation">
130 The singlehtml builder doesn't handle this toctree call when the
131 toctree is empty. Skip building this for now.
133 {% if 'singlehtml' not in builder %}
134 {% set global_toc = toctree(maxdepth=theme_navigation_depth|int, collapse=theme_collapse_navigation, includehidden=True) %}
140 <div class=
"local-toc">{{ toc }}
</div>
147 <section data-toggle=
"wy-nav-shift" class=
"wy-nav-content-wrap">
149 {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
150 <nav class=
"wy-nav-top" role=
"navigation" aria-label=
"top navigation">
151 {% block mobile_nav %}
152 <i data-toggle=
"wy-nav-top" class=
"fa fa-bars"></i>
153 <a href=
"{{ pathto(master_doc) }}">{{ project }}
</a>
159 <div class=
"wy-nav-content">
160 <div class=
"rst-content">
161 {% include
"breadcrumbs.html" %}
162 <div role=
"main" class=
"document" itemscope=
"itemscope" itemtype=
"http://schema.org/Article">
163 <div itemprop=
"articleBody">
164 {% block body %}{% endblock %}
166 <div class=
"articleComments">
167 {% block comments %}{% endblock %}
170 {% include
"footer.html" %}
177 {% include
"versions.html" %}
179 {% if not embedded %}
181 <script type=
"text/javascript">
182 var DOCUMENTATION_OPTIONS = {
183 URL_ROOT:'{{ url_root }}',
184 VERSION:'{{ release|e }}',
185 LANGUAGE:'{{ language }}',
186 COLLAPSE_INDEX:false,
187 FILE_SUFFIX:'{{ '' if no_search_suffix else file_suffix }}',
188 HAS_SOURCE: {{ has_source|lower }},
189 SOURCELINK_SUFFIX: '{{ sourcelink_suffix }}'
192 {%- for scriptfile in script_files %}
193 <script type=
"text/javascript" src=
"{{ pathto(scriptfile, 1) }}"></script>
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>
203 {# STICKY NAVIGATION #}
204 {% if theme_sticky_navigation %}
205 <script type=
"text/javascript">
207 SphinxRtdTheme.StickyNav.enable();
212 {%- block footer %} {% endblock %}