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