manual/theme/pyx/layout.html

   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 ' &raquo;' 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 = " &mdash; "|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="http://pyx.sourceforge.net">PyX Homepage</a>{{ reldelim1 }}</li>
  39         <li><a href="{{ pathto(master_doc) }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
  40         {%- endblock %}
  41         {%- for parent in parents %}
  42           <li><a href="{{ parent.link|e }}" {% if loop.last %}{{ accesskey("U") }}{% endif %}>{{ parent.title }}</a>{{ reldelim1 }}</li>
  43         {%- endfor %}
  44         <li>{{ title|striptags|e }}</li>
  45       </ul>
  46     </div>
  47 {%- endmacro %}
  48
  49 {%- macro sidebar() %}
  50       {%- if render_sidebar %}
  51       <div class="sphinxsidebar">
  52         <div class="sphinxsidebarwrapper">
  53           {%- for sidebartemplate in sidebars %}
  54             {%- macro thissidebar() %}{%- include sidebartemplate -%}{% endmacro -%}
  55             {% if thissidebar()|length %}
  56               <div class="sidebarbox">{{ thissidebar() }}</div>
  57             {% endif %}
  58           {%- endfor %}
  59         </div>
  60       </div>
  61       {%- endif %}
  62 {%- endmacro %}
  63
  64 {%- macro script() %}
  65     <script type="text/javascript">
  66       var DOCUMENTATION_OPTIONS = {
  67         URL_ROOT:    '{{ url_root }}',
  68         VERSION:     '{{ release|e }}',
  69         COLLAPSE_INDEX: false,
  70         FILE_SUFFIX: '{{ '' if no_search_suffix else file_suffix }}',
  71         HAS_SOURCE:  {{ has_source|lower }}
  72       };
  73     </script>
  74     {%- for scriptfile in script_files %}
  75     <script type="text/javascript" src="{{ pathto(scriptfile, 1) }}"></script>
  76     {%- endfor %}
  77 {%- endmacro %}
  78
  79 {%- macro css() %}
  80     <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
  81     <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
  82     {%- for cssfile in css_files %}
  83     <link rel="stylesheet" href="{{ pathto(cssfile, 1) }}" type="text/css" />
  84     {%- endfor %}
  85 {%- endmacro %}
  86
  87 <html xmlns="http://www.w3.org/1999/xhtml">
  88   <head>
  89     <meta http-equiv="Content-Type" content="text/html; charset={{ encoding }}" />
  90     {{ metatags }}
  91     {%- block htmltitle %}
  92     <title>{{ title|striptags|e }}{{ titlesuffix }}</title>
  93     {%- endblock %}
  94     {{ css() }}
  95     {%- if not embedded %}
  96     {{ script() }}
  97     {%- if use_opensearch %}
  98     <link rel="search" type="application/opensearchdescription+xml"
  99           title="{% trans docstitle=docstitle|e %}Search within {{ docstitle }}{% endtrans %}"
 100           href="{{ pathto('_static/opensearch.xml', 1) }}"/>
 101     {%- endif %}
 102     {%- if favicon %}
 103     <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
 104     {%- endif %}
 105     {%- endif %}
 106 {%- block linktags %}
 107     {%- if hasdoc('about') %}
 108     <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
 109     {%- endif %}
 110     {%- if hasdoc('genindex') %}
 111     <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
 112     {%- endif %}
 113     {%- if hasdoc('search') %}
 114     <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
 115     {%- endif %}
 116     {%- if hasdoc('copyright') %}
 117     <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
 118     {%- endif %}
 119     <link rel="top" title="{{ docstitle|e }}" href="{{ pathto('index') }}" />
 120     {%- if parents %}
 121     <link rel="up" title="{{ parents[-1].title|striptags|e }}" href="{{ parents[-1].link|e }}" />
 122     {%- endif %}
 123     {%- if next %}
 124     <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
 125     {%- endif %}
 126     {%- if prev %}
 127     <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
 128     {%- endif %}
 129 {%- endblock %}
 130 {%- block extrahead %} {% endblock %}
 131   </head>
 132   <body>
 133 {%- block header %}{% endblock %}
 134
 135 <div class="relatedtop">
 136 {%- block relbar1 %}{{ relbar() }}{% endblock %}
 137 </div>
 138
 139 {%- block content %}
 140   {%- block sidebar1 %} {# possible location for sidebar #} {% endblock %}
 141
 142     <div class="document">
 143   {%- block document %}
 144       <div class="documentwrapper">
 145       {%- if render_sidebar %}
 146         <div class="bodywrapper">
 147       {%- endif %}
 148           <div class="body">
 149             {% block body %} {% endblock %}
 150           </div>
 151       {%- if render_sidebar %}
 152         </div>
 153       {%- endif %}
 154       </div>
 155   {%- endblock %}
 156
 157   {%- block sidebar2 %}{{ sidebar() }}{% endblock %}
 158       <div class="clearer"></div>
 159     </div>
 160 {%- endblock %}
 161
 162 <div class="relatedbottom">
 163 {%- block relbar2 %}{{ relbar() }}{% endblock %}
 164 </div>
 165
 166 {%- block footer %}
 167     <div class="footer">
 168     {%- if show_copyright %}
 169       {%- if hasdoc('copyright') %}
 170         {% trans path=pathto('copyright'), copyright=copyright|e %}&copy; <a href="{{ path }}">Copyright</a> {{ copyright }}.{% endtrans %}
 171       {%- else %}
 172         {% trans copyright=copyright|e %}&copy; Copyright {{ copyright }}.{% endtrans %}
 173       {%- endif %}
 174     {%- endif %}
 175     {%- if last_updated %}
 176       {% trans last_updated=last_updated|e %}Last updated on {{ last_updated }}.{% endtrans %}
 177     {%- endif %}
 178     {%- if show_sphinx %}
 179       {% trans sphinx_version=sphinx_version|e %}Created using <a href="http://sphinx-doc.org/">Sphinx</a> {{ sphinx_version }}.{% endtrans %}
 180     {%- endif %}
 181     </div>
 182 {%- endblock %}
 183   </body>
 184 </html>