nandi.uk
Fork of daniellemaywood.uk/gleam — Wasm codegen work
4.0 kB
137 lines
1{#
2 SPDX-License-Identifier: Apache-2.0
3 SPDX-FileCopyrightText: 2020 The Gleam contributors
4#}
5{% extends "documentation_layout.html" %}
6
7{% block sidebar_content %}
8{% if !types.is_empty() %}
9<h2>Types</h2>
10<ul>
11 {% for typ in types %}
12 <li><a href="#{{ typ.name }}">{{ typ.name }}</a></li>
13 {% endfor %}
14</ul>
15{% endif %}
16
17{% if !values.is_empty() %}
18<h2>Values</h2>
19<ul>
20 {% for value in values %}
21 <li><a href="#{{ value.name }}">{{ value.name }}</a></li>
22 {% endfor %}
23</ul>
24{% endif %}
25{% endblock %}
26
27{% block content %}
28<h1 id="module-name" class="module-name">
29 <a href="#module-name">{{ module_name }}</a>
30 <svg class="icon icon-gleam-chasse"><use xlink:href="#icon-gleam-chasse"></use></svg>
31</h1>
32{{ documentation|safe }}
33
34{% if !types.is_empty() %}
35<section class="module-members">
36 <h1 id="module-types" class="module-member-kind">
37 <a href="#module-types">Types</a>
38 <svg class="icon icon-gleam-chasse-2"><use xlink:href="#icon-gleam-chasse-2"></use></svg>
39 </h1>
40
41 {% for typ in types %}
42 <div class="member">
43 <div class="member-name">
44 <h2 id="{{ typ.name }}">
45 <a href="#{{ typ.name }}">
46 {{ typ.name }}
47 </a>
48 </h2>{% if typ.opaque %} <span class="visibility-tag">opaque</span> {% endif %}
49 {% if !typ.source_url.is_empty() %}
50 <a class="member-source" alt="View Source" title="View Source" href="{{ typ.source_url|safe }}">
51 </>
52 </a>
53 {% endif %}
54 </div>
55 {% if !typ.deprecation_message.is_empty() %}
56 <p>
57 <b>Deprecated:</b> {{ typ.deprecation_message }}
58 </p>
59 {% endif %}
60 <div class="custom-type-constructors">
61 <div class="rendered-markdown">{{ typ.documentation|safe }}</div>
62 <pre><code class="hljs hljs-ignore">{{ typ.definition|safe }}</code></pre>
63 {% if !typ.constructors.is_empty() %}
64 <h3>
65 Constructors
66 </h3>
67 <ul class="constructor-list">
68 {% for constructor in typ.constructors %}
69 <li class="constructor-item">
70 <div class="constructor-row">
71 <svg class="icon icon-star"><use xlink:href="#icon-star"></use></svg>
72 <pre class="constructor-name"><code class="hljs hljs-ignore">{{ constructor.definition|safe }}</code></pre>
73 </div>
74
75 <div class="constructor-item-docs">
76 {{ constructor.documentation|safe }}
77
78 {% if !constructor.arguments.is_empty() %}
79 <h4>
80 Arguments
81 </h4>
82
83 <dl class="constructor-argument-list">
84 {% for argument in constructor.arguments %}
85 <dt class="constructor-argument-label">
86 {{ argument.name }}
87 </dt>
88 <dd class="constructor-argument-doc">
89 {{ argument.doc|safe }}
90 </dd>
91 {% endfor %}
92 </dl>
93 {% endif %}
94 </div>
95 </li>
96 {% endfor %}
97 </ul>
98 {% endif %}
99 </div>
100 </div>
101 {% endfor %}
102</section>
103{% endif %}
104
105{% if !values.is_empty() %}
106<section class="module-members">
107 <h1 id="module-values" class="module-member-kind">
108 <a href="#module-values">Values</a>
109 <svg class="icon icon-gleam-chasse"><use xlink:href="#icon-gleam-chasse"></use></svg>
110 </h1>
111 {% for value in values %}
112 <div class="member">
113 <div class="member-name">
114 <h2 id="{{ value.name }}">
115 <a href="#{{ value.name }}">
116 {{ value.name }}
117 </a>
118 </h2>
119 {% if !value.source_url.is_empty() %}
120 <a class="member-source" alt="View Source" title="View Source" href="{{ value.source_url|safe }}">
121 </>
122 </a>
123 {% endif %}
124 </div>
125
126 <pre><code class="hljs hljs-ignore">{{ value.definition|safe }}</code></pre>
127 {% if !value.deprecation_message.is_empty() %}
128 <p>
129 <b>Deprecated:</b> {{ value.deprecation_message }}
130 </p>
131 {% endif %}
132 <div class="rendered-markdown">{{ value.documentation|safe }}</div>
133 </div>
134 {% endfor %}
135</section>
136{% endif %}
137{% endblock %}