doc/.templates/layout.html

   1 {# Layout modifications for the Pylit documentation #}
   2 {# Filename: .templates/layout.html #}
   3 {% extends '!layout.html' %}
   4
   5 <!-- Navigation bar                                -->
   6 <!-- ============================================= -->
   7 <!--                                               -->
   8 <!-- Add current page                              -->
   9 <!-- Add up link                                   -->
  10
  11 {%- block relbaritems %}
  12   <li>{{ title }}</li>
  13   <!-- <li>{{ pagename }}</li> -->
  14 <!-- Does not work: places the up link on the next line    -->
  15   <!-- {% if parents %}                                                                 -->
  16   <!--   <li class="right"><a href="{{ parents[-1].link }}">up</a> {{ reldelim2 }}</li> -->
  17   <!-- {% endif %}                                                                      -->
  18 {% endblock %}
  19
  20 <!-- use URL path separator as delimiter -->
  21 {%- set reldelim1 = ' / ' %}
  22
  23
  24 <!-- Sidebar                                       -->
  25 <!-- ============================================= -->
  26
  27 <!-- Table Of Contents -->
  28 <!-- ----------------- -->
  29 <!--                   -->
  30 <!-- Shorter heading   -->
  31
  32 {%- block sidebartoc %}
  33   {%- if display_toc %}
  34     <h3>Contents</h3>
  35     <!-- Contents of current page -->
  36     {{ toc }}
  37     <!-- Site Contents -->
  38     <!-- {{ toctree() }} -->
  39     <hr />
  40   {%- endif %}
  41 {%- endblock %}
  42
  43
  44 <!-- Links             -->
  45 <!-- ----------------- -->
  46 <!--                   -->
  47 <!-- Shorter headings  -->
  48 <!-- Add Up link       -->
  49
  50 {%- block sidebarrel %}
  51   {%- if prev %}
  52     <h4>Previous Page</h4>
  53     <p class="topless">
  54       <a href="{{ prev.link|e }}" title="previous section">{{ prev.title }}</a>
  55     </p>
  56   {%- endif %}
  57   {%- if next %}
  58     <h4>Next Page</h4>
  59     <p class="topless">
  60       <a href="{{ next.link|e }}" title="next section">{{ next.title }}</a>
  61     </p>
  62   {%- endif %}
  63   {%- if pagename != "index" %}
  64     <h4>Up</h4>
  65     <p class="topless">
  66     {%- if parents %}
  67        <a href="{{ parents[-1].link|e }}" title="up">{{ parents[-1].title }}</a>
  68     {%- else %}
  69        <a href="{{ pathto('index') }}" title="up">{{ shorttitle }}</a>
  70     {%- endif %}
  71     </p>
  72   {%- endif %}
  73   <hr />
  74 {%- endblock %}
  75
  76 <!-- Search                                        -->
  77 <!-- --------------------------------------------- -->
  78 <!-- smaller text area (size="12" instead of "18") -->
  79
  80 {%- block sidebarsearch %}
  81   {%- if pagename != "search" %}
  82     <h3>Search this site</h3>
  83     <form class="search" action="{{ pathto('search') }}" method="get">
  84       <input type="text" name="q" size="12" />
  85       <input type="submit" value="Go" />
  86       <input type="hidden" name="check_keywords" value="yes" />
  87       <input type="hidden" name="area" value="default" />
  88     </form>
  89     {%- if builder == 'web' %}
  90     <p style="font-size: 90%">Enter a module, class or function name.</p>
  91     {%- endif %}
  92   {%- endif %}
  93 {%- endblock %}
  94
  95
  96 <!-- Footer                                        -->
  97 <!-- --------------------------------------------- -->
  98
  99 {% block footer %}
 100  <p class="thanks">
 101   <!-- Thanks to              -->
 102   <!-- for hosting this site. -->
 103  </p>
 104 {% endblock %}