doc/.templates/layout.html
changeset 0 b97547f5f1fa
child 37 dcc7c04469f1
equal deleted inserted replaced
-1:000000000000 0:b97547f5f1fa
       
     1 {%- block doctype -%}
       
     2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
       
     3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
       
     4 {%- endblock %}
       
     5 {%- set reldelim1 = reldelim1 is not defined and ' &raquo;' or reldelim1 %}
       
     6 {%- set reldelim2 = reldelim2 is not defined and ' |' or reldelim2 %}
       
     7 {%- macro relbar %}
       
     8     <div class="related">
       
     9       <h3>Navigation</h3>
       
    10       <ul>
       
    11         {%- for rellink in rellinks %}
       
    12         <li class="right" {% if loop.first %}style="margin-right: 10px"{% endif %}>
       
    13           <a href="{{ pathto(rellink[0]) }}" title="{{ rellink[1]|striptags }}"
       
    14              accesskey="{{ rellink[2] }}">{{ rellink[3] }}</a>
       
    15           {%- if not loop.first %}{{ reldelim2 }}{% endif %}</li>
       
    16         {%- endfor %}
       
    17         {%- block rootrellink %}
       
    18         <li><a href="{{ pathto('index') }}">{{ shorttitle }}</a>{{ reldelim1 }}</li>
       
    19         {%- endblock %}
       
    20         {%- for parent in parents %}
       
    21           <li><a href="{{ parent.link|e }}" accesskey="U">{{ parent.title }}</a>{{ reldelim1 }}</li>
       
    22         {%- endfor %}
       
    23         {%- block relbaritems %}{% endblock %}
       
    24       </ul>
       
    25     </div>
       
    26 {%- endmacro %}
       
    27 {%- macro sidebar %}
       
    28       {%- if builder != 'htmlhelp' %}
       
    29       <div class="sphinxsidebar">
       
    30         <div class="sphinxsidebarwrapper">
       
    31           {%- block sidebarlogo %}
       
    32           {%- if logo %}
       
    33             <p class="logo"><img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/></p>
       
    34           {%- endif %}
       
    35           {%- endblock %}
       
    36           {%- block sidebartoc %}
       
    37           {%- if display_toc %}
       
    38             <h3>Table Of Contents</h3>
       
    39             {{ toc }}
       
    40           {%- endif %}
       
    41           {%- endblock %}
       
    42           {%- block sidebarrel %}
       
    43           {%- if prev %}
       
    44             <h4>Previous topic</h4>
       
    45             <p class="topless"><a href="{{ prev.link|e }}" title="previous chapter">{{ prev.title }}</a></p>
       
    46           {%- endif %}
       
    47           {%- if next %}
       
    48             <h4>Next topic</h4>
       
    49             <p class="topless"><a href="{{ next.link|e }}" title="next chapter">{{ next.title }}</a></p>
       
    50           {%- endif %}
       
    51           {%- endblock %}
       
    52           {%- if sourcename %}
       
    53             <h3>This Page</h3>
       
    54             <ul class="this-page-menu">
       
    55             {%- if builder == 'web' %}
       
    56               <li><a href="#comments">Comments ({{ comments|length }} so far)</a></li>
       
    57               <li><a href="{{ pathto('@edit/' + sourcename)|e }}">Suggest Change</a></li>
       
    58               <li><a href="{{ pathto('@source/' + sourcename)|e }}">Show Source</a></li>
       
    59             {%- elif builder == 'html' %}
       
    60               <li><a href="{{ pathto('_sources/' + sourcename, true)|e }}">Show Source</a></li>
       
    61             {%- endif %}
       
    62             </ul>
       
    63           {%- endif %}
       
    64           {%- if customsidebar %}
       
    65           {{ rendertemplate(customsidebar) }}
       
    66           {%- endif %}
       
    67           {%- block sidebarsearch %}
       
    68           {%- if pagename != "search" %}
       
    69             <h3>{{ builder == 'web' and 'Keyword' or 'Quick' }} search</h3>
       
    70             <form class="search" action="{{ pathto('search') }}" method="get">
       
    71               <input type="text" name="q" size="18" /> <input type="submit" value="Go" />
       
    72               <input type="hidden" name="check_keywords" value="yes" />
       
    73               <input type="hidden" name="area" value="default" />
       
    74             </form>
       
    75             {%- if builder == 'web' %}
       
    76             <p style="font-size: 90%">Enter a module, class or function name.</p>
       
    77             {%- endif %}
       
    78           {%- endif %}
       
    79           {%- endblock %}
       
    80         </div>
       
    81       </div>
       
    82       {%- endif %}
       
    83 {%- endmacro -%}
       
    84 
       
    85 <html xmlns="http://www.w3.org/1999/xhtml">
       
    86   <head>
       
    87     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
       
    88     {%- if builder != 'htmlhelp' %}
       
    89       {%- set titlesuffix = " &mdash; " + docstitle %}
       
    90     {%- endif %}
       
    91     <title>{{ title|striptags }}{{ titlesuffix }}</title>
       
    92     {%- if builder == 'web' %}
       
    93     <link rel="stylesheet" href="{{ pathto('index') }}?do=stylesheet{%
       
    94       if in_admin_panel %}&admin=yes{% endif %}" type="text/css" />
       
    95     {%- for link, type, title in page_links %}
       
    96     <link rel="alternate" type="{{ type|e(true) }}" title="{{ title|e(true) }}" href="{{ link|e(true) }}" />
       
    97     {%- endfor %}
       
    98     {%- else %}
       
    99     <link rel="stylesheet" href="{{ pathto('_static/' + style, 1) }}" type="text/css" />
       
   100     <link rel="stylesheet" href="{{ pathto('_static/pygments.css', 1) }}" type="text/css" />
       
   101     {%- endif %}
       
   102     {%- if builder != 'htmlhelp' %}
       
   103     <script type="text/javascript">
       
   104       var DOCUMENTATION_OPTIONS = {
       
   105           URL_ROOT:    '{{ pathto("", 1) }}',
       
   106           VERSION:     '{{ release }}',
       
   107           COLLAPSE_MODINDEX: false,
       
   108           FILE_SUFFIX: '{{ file_suffix }}'
       
   109       };
       
   110     </script>
       
   111     <script type="text/javascript" src="{{ pathto('_static/jquery.js', 1) }}"></script>
       
   112     <script type="text/javascript" src="{{ pathto('_static/interface.js', 1) }}"></script>
       
   113     <script type="text/javascript" src="{{ pathto('_static/doctools.js', 1) }}"></script>
       
   114     {%- if use_opensearch %}
       
   115     <link rel="search" type="application/opensearchdescription+xml"
       
   116           title="Search within {{ docstitle }}"
       
   117           href="{{ pathto('_static/opensearch.xml', 1) }}"/>
       
   118     {%- endif %}
       
   119     {%- if favicon %}
       
   120     <link rel="shortcut icon" href="{{ pathto('_static/' + favicon, 1) }}"/>
       
   121     {%- endif %}
       
   122     {%- endif %}
       
   123 {%- block rellinks %}
       
   124     {%- if hasdoc('about') %}
       
   125     <link rel="author" title="About these documents" href="{{ pathto('about') }}" />
       
   126     {%- endif %}
       
   127     <link rel="contents" title="Global table of contents" href="{{ pathto('contents') }}" />
       
   128     <link rel="index" title="Global index" href="{{ pathto('genindex') }}" />
       
   129     <link rel="search" title="Search" href="{{ pathto('search') }}" />
       
   130     {%- if hasdoc('copyright') %}
       
   131     <link rel="copyright" title="Copyright" href="{{ pathto('copyright') }}" />
       
   132     {%- endif %}
       
   133     <link rel="top" title="{{ docstitle }}" 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 
       
   148 {% block logilablogo %}
       
   149 <div class="logilablogo">
       
   150 	<a class="logogo" href="http://www.logilab.org"><img border="0" src="{{ pathto('_static/logilab.png', 1) }}"/></a>
       
   151   </div>
       
   152 {% endblock %}
       
   153 
       
   154 {%- block relbar1 %}{{ relbar() }}{% endblock %}
       
   155 
       
   156 {%- block sidebar1 %}{# possible location for sidebar #}{% endblock %}
       
   157 
       
   158 {%- block document %}
       
   159     <div class="document">
       
   160       <div class="documentwrapper">
       
   161       {%- if builder != 'htmlhelp' %}
       
   162         <div class="bodywrapper">
       
   163       {%- endif %}
       
   164           <div class="body">
       
   165             {% block body %}{% endblock %}
       
   166           </div>
       
   167       {%- if builder != 'htmlhelp' %}
       
   168         </div>
       
   169       {%- endif %}
       
   170       </div>
       
   171 {%- endblock %}
       
   172 
       
   173 {%- block sidebar2 %}{{ sidebar() }}{% endblock %}
       
   174       <div class="clearer"></div>
       
   175     </div>
       
   176 
       
   177 {%- block relbar2 %}{{ relbar() }}{% endblock %}
       
   178 
       
   179 {%- block footer %}
       
   180     <div class="footer">
       
   181     {%- if hasdoc('copyright') %}
       
   182       &copy; <a href="{{ pathto('copyright') }}">Copyright</a> {{ copyright }}.
       
   183     {%- else %}
       
   184       &copy; Copyright {{ copyright }}.
       
   185     {%- endif %}
       
   186     {%- if last_updated %}
       
   187       Last updated on {{ last_updated }}.
       
   188     {%- endif %}
       
   189     {%- if show_sphinx %}
       
   190       Created using <a href="http://sphinx.pocoo.org/">Sphinx</a>.
       
   191     {%- endif %}
       
   192     </div>
       
   193 {%- endblock %}
       
   194   </body>
       
   195 </html>