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