| 1 |
{# |
| 2 |
basic/layout.html |
| 3 |
~~~~~~~~~~~~~~~~~ |
| 4 |
|
| 5 |
Master layout template for Sphinx themes. |
| 6 |
|
| 7 |
:copyright: Copyright 2007-2010 by the Sphinx team, see AUTHORS. |
| 8 |
:license: BSD, see LICENSE for details. |
| 9 |
#} |
| 10 |
{%- block doctype -%} |
| 11 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
| 12 |
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 13 |
{%- endblock %} |
| 14 |
{%- set reldelim1 = reldelim1 is not defined and ' »' or reldelim1 %} |
| 15 |
{%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %} |
| 16 |
{%- set render_sidebar = (not embedded) and (not theme_nosidebar|tobool) and |
| 17 |
(not sidebars == []) %} |
| 18 |
{%- set url_root = pathto('', 1) %} |
| 19 |
{%- if url_root == '#' %}{% set url_root = '' %}{% endif %} |
| 20 |
|
| 21 |
{%- macro relbar() %} |
| 22 |
<div class="related"> |
| 23 |
<h3>{{ _('Navigation') }}</h3> |
| 24 |
<ul> |
| 25 |
{%- for rellink in rellinks %} |
| 26 |
<li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}> |
| 27 |
<a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags }}" |
| 28 |
{{ accesskey(rellink[2]) }}>{{ rellink[3] }}</a> |
| 29 |
{%- if not loop.first %}{{ reldelim2 }}{% endif %}</li> |
| 30 |
{%- endfor %} |
| 31 |
{%- block rootrellink %} |
| 32 |
<li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li> |
| 33 |
{%- endblock %} |
| 34 |
{%- for parent in parents %} |
| 35 |
<li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li> |
| 36 |
{%- endfor %} |
| 37 |
{%- block relbaritems %} {% endblock %} |
| 38 |
</ul> |
| 39 |
</div> |
| 40 |
{%- endmacro %} |
| 41 |
|
| 42 |
{%- macro sidebar() %} |
| 43 |
{%- if render_sidebar %} |
| 44 |
<div class="sphinxsidebar"> |
| 45 |
<div class="sphinxsidebarwrapper"> |
| 46 |
{%- block sidebarlogo %} |
| 47 |
{%- if logo %} |
| 48 |
<p class="logo"><a href="{{ pathto(master_doc) }}"> |
| 49 |
<img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/> |
| 50 |
</a></p> |
| 51 |
{%- endif %} |
| 52 |
{%- endblock %} |
| 53 |
{%- if sidebars != None %} |
| 54 |
{#- new style sidebar: explicitly include/exclude templates #} |
| 55 |
{%- for sidebartemplate in sidebars %} |
| 56 |
{%- include sidebartemplate %} |
| 57 |
{%- endfor %} |
| 58 |
{%- else %} |
| 59 |
{#- old style sidebars: using blocks -- should be deprecated #} |
| 60 |
{%- block sidebartoc %} |
| 61 |
{%- include "localtoc.html" %} |
| 62 |
{%- endblock %} |
| 63 |
{%- block sidebarrel %} |
| 64 |
{%- include "relations.html" %} |
| 65 |
{%- endblock %} |
| 66 |
{%- block sidebarsourcelink %} |
| 67 |
{%- include "sourcelink.html" %} |
| 68 |
{%- endblock %} |
| 69 |
{%- if customsidebar %} |
| 70 |
{%- include customsidebar %} |
| 71 |
{%- endif %} |
| 72 |
{%- block sidebarsearch %} |
| 73 |
{%- include "searchbox.html" %} |
| 74 |
{%- endblock %} |
| 75 |
{%- endif %} |
| 76 |
</div> |
| 77 |
</div> |
| 78 |
{%- endif %} |
| 79 |
{%- endmacro %} |
| 80 |
|
| 81 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 82 |
<head> |
| 83 |
<meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" /> |
| 84 |
{{ metatags }} |
| 85 |
{%- if not embedded and docstitle %} |
| 86 |
{%- set titlesuffix = " — "|safe + docstitle|e %} |
| 87 |
{%- else %} |
| 88 |
{%- set titlesuffix = "" %} |
| 89 |
{%- endif %} |
| 90 |
{%- block htmltitle %} |
| 91 |
<title>{{ title|striptags }}{{ titlesuffix }}</title> |
| 92 |
{%- endblock %} |
| 93 |
<link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" /> |
| 94 |
<link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" /> |
| 95 |
{%- for cssfile in css_files %} |
| 96 |
<link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" /> |
| 97 |
{%- endfor %} |
| 98 |
{%- if not embedded %} |
| 99 |
<script type="text/javascript"> |
| 100 |
var DOCUMENTATION_OPTIONS = { |
| 101 |
URL_ROOT: '{{ url_root }}', |
| 102 |
VERSION: '{{ release|e }}', |
| 103 |
COLLAPSE_INDEX: false, |
| 104 |
FILE_SUFFIX: '{{ file_suffix }}', |
| 105 |
HAS_SOURCE: {{ has_source|lower }} |
| 106 |
}; |
| 107 |
</script> |
| 108 |
{%- for scriptfile in script_files %} |
| 109 |
<script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script> |
| 110 |
{%- endfor %} |
| 111 |
{%- if use_opensearch %} |
| 112 |
<link rel="search" type="application/opensearchdescription+xml" |
| 113 |
title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}" |
| 114 |
href="{{ pathto('_static/opensearch.xml', 1) }}"/> |
| 115 |
{%- endif %} |
| 116 |
{%- if favicon %} |
| 117 |
<link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/> |
| 118 |
{%- endif %} |
| 119 |
{%- endif %} |
| 120 |
{%- block linktags %} |
| 121 |
{%- if hasdoc('about') %} |
| 122 |
<link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" /> |
| 123 |
{%- endif %} |
| 124 |
{%- if hasdoc('genindex') %} |
| 125 |
<link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" /> |
| 126 |
{%- endif %} |
| 127 |
{%- if hasdoc('search') %} |
| 128 |
<link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" /> |
| 129 |
{%- endif %} |
| 130 |
{%- if hasdoc('copyright') %} |
| 131 |
<link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" /> |
| 132 |
{%- endif %} |
| 133 |
<link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" /> |
| 134 |
{%- if parents %} |
| 135 |
<link rel="up" title="{{ parents[-1].title|striptags }}" href="{{ parents[-1].link|e }}" /> |
| 136 |
{%- endif %} |
| 137 |
{%- if next %} |
| 138 |
<link rel="next" title="{{ next.title|striptags }}" href="{{ next.link|e }}" /> |
| 139 |
{%- endif %} |
| 140 |
{%- if prev %} |
| 141 |
<link rel="prev" title="{{ prev.title|striptags }}" href="{{ prev.link|e }}" /> |
| 142 |
{%- endif %} |
| 143 |
{%- endblock %} |
| 144 |
{%- block extrahead %} {% endblock %} |
| 145 |
</head> |
| 146 |
<body> |
| 147 |
{%- block header %}{% endblock %} |
| 148 |
|
| 149 |
{%- block relbar1 %}{{ relbar() }}{% endblock %} |
| 150 |
|
| 151 |
{%- block content %} |
| 152 |
{%- block sidebar1 %} {# possible location for sidebar #} {% endblock %} |
| 153 |
|
| 154 |
<div class="document"> |
| 155 |
{%- block document %} |
| 156 |
<div class="documentwrapper"> |
| 157 |
{%- if render_sidebar %} |
| 158 |
<div class="bodywrapper"> |
| 159 |
{%- endif %} |
| 160 |
<div class="body"> |
| 161 |
{% block body %} {% endblock %} |
| 162 |
</div> |
| 163 |
{%- if render_sidebar %} |
| 164 |
</div> |
| 165 |
{%- endif %} |
| 166 |
</div> |
| 167 |
{%- endblock %} |
| 168 |
|
| 169 |
{%- block sidebar2 %}{{ sidebar() }}{% endblock %} |
| 170 |
<div class="clearer"></div> |
| 171 |
</div> |
| 172 |
{%- endblock %} |
| 173 |
|
| 174 |
{%- block relbar2 %}{{ relbar() }}{% endblock %} |
| 175 |
|
| 176 |
{%- block footer %} |
| 177 |
<div class="footer"> |
| 178 |
{%- if show_copyright %} |
| 179 |
{%- if hasdoc('copyright') %} |
| 180 |
{% trans path=pathto('copyright'), copyright=copyright|e %}© <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %} |
| 181 |
{%- else %} |
| 182 |
{% trans copyright=copyright|e %}© Copyright {{ copyright }}.{% endtrans %} |
| 183 |
{%- endif %} |
| 184 |
{%- endif %} |
| 185 |
{%- if last_updated %} |
| 186 |
{% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %} |
| 187 |
{%- endif %} |
| 188 |
{%- if show_sphinx %} |
| 189 |
{% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %} |
| 190 |
{%- endif %} |
| 191 |
</div> |
| 192 |
{%- endblock %} |
| 193 |
</body> |
| 194 |
</html> |