Merge branch 'master' of git@github.com:fnp/wolnelektury
[wolnelektury.git] / apps / piston / templates / documentation.html
1 {% load markup %}
2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"
3 "http://www.w3.org/TR/html4/strict.dtd">
4 <html>
5         <head>
6                 <title>
7                         Piston generated documentation
8                 </title>
9                 <style type="text/css">
10                         body {
11                                 background: #fffff0;
12                                 font: 1em "Helvetica Neue", Verdana;
13                                 padding: 0 0 0 25px;
14                         }
15                 </style>
16         </head>
17         <body>
18                 <h1>API Documentation</h1>
19
20                 {% for doc in docs %}
21
22                         <h3>{{ doc.name|cut:"Handler" }}:</h3>
23
24                         <p>
25                                 {{ doc.get_doc|default:""|restructuredtext }}
26                         </p>
27
28                         <p>
29                                 URL: <b>{{ doc.get_resource_uri_template }}</b>
30                         </p>
31
32                         <p>
33                                 Accepted methods: {% for meth in doc.allowed_methods %}<b>{{ meth }}</b>{% if not forloop.last %}, {% endif %}{% endfor %}
34                         </p>
35
36                         <dl>
37                                 {% for method in doc.get_all_methods %}
38
39                                         <dt>
40                                                 method <i>{{ method.name }}</i>({{ method.signature }}){% if method.stale %} <i>- inherited</i>{% else %}:{% endif %}
41
42                                         </dt>
43
44                                         {% if method.get_doc %}
45                                                 <dd>
46                                                         {{ method.get_doc|default:""|restructuredtext }}
47                                                 <dd>
48                                         {% endif %}
49
50                                 {% endfor %}
51                         </dl>
52
53                 {% endfor %}
54         </body>
55 </html>