summaryrefslogtreecommitdiff
path: root/doc/templates/index.html
blob: 70d793180c9fe321a8f14ec063d7fec6a6e720d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd" "">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
 <head>
  <title>{{ spec.title }} &mdash; v{{ spec.version }}</title>
  <meta charset="UTF-8">
  <link rel="stylesheet" href="style.css" type="text/css"/>
  <link rel="shortcut icon" type="image/png" media="all" href="favicon.png" />
 </head>
 <body>
  <div class="header">
   <h1>{{ spec.title }}</h1>
   <a href="#interfaces">Interfaces</a>
   (<a href="interfaces.html">Compact</a>)
{% if spec.generic_types|length > 0 %}
   | <a href="generic-types.html">Generic Types</a>
{% endif %}
{% if spec.errors|length > 0 %}
   | <a href="errors.html">Errors</a>
{% endif %}
   | <a href="fullindex.html">Full Index</a>
  </div>

  <div class="main">
  <h3 class="version">Version {{ spec.version }}</h3>
  <div class="legal">
   <ul class="copyrights">
    {% for c in spec.copyrights %}
    <li>{{ c }}</li>
    {% endfor %}
   </ul>

   {% for l in spec.license %}
   <p>{{ l }}</p>
   {% endfor %}
  </div>

  <a name="interfaces"></a>
  <h3>Interfaces</h3>
  <ul>
  {% macro output(items) -%}
   {% for item in items %}
    {% if item.__class__.__name__ == 'Section' %}
     {% set anchor = item.short_name.replace(' ', '-') %}
     <li class="chapter">
      <a name="{{ anchor }}"></a>
      {{ item.short_name }}
      <span class="permalink">(<a href="#{{ anchor }}">Permalink</a>)</span>
     </li>
     {{ item.get_docstring() }}
     <ul>
      {{ output(item.items) }}
     </ul>
    {% else %}
     {% if item.causes_havoc %}
      <li class="causes-havoc">
     {% elif item.is_deprecated %}
      <li class="deprecated">
     {% else %}
      <li>
     {% endif %}
      <a href="{{ item.get_url() }}">{{ item.name }}</a>
      {% if item.causes_havoc %}
       (unstable)
      {% elif item.is_deprecated %}
       (deprecated)
      {% endif %}
     </li>
    {% endif %}
   {% endfor %}
  {%- endmacro %}
  {{ output(spec.items) }}
  </ul>

{% if spec.generic_types|length > 0 or spec.errors|length > 0 %}
  <a name="other"></a>
  <h3>Other</h3>
  <ul>
  {% if spec.generic_types|length > 0 %}
   <li><a href="generic-types.html">Generic Types</a></li>
  {% endif %}
  {% if spec.errors|length > 0 %}
   <li><a href="errors.html">Errors</a></li>
  {% endif %}
  </ul>
{% endif %}

  </div>
 </body>
</html>