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