gluon_doc 0.18.3

The documentation generator for the gluon programming language
Documentation 
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
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    {{style ""}}
    <title>{{name}}</title>
</head>
<body>
    <header>
        <nav class="navbar navbar-dark bg-dark box-shadow">
            <ol class="breadcrumb">
                {{breadcrumbs name}}
            </ol>
        </nav>
    </header>

    <div class="row">

        <nav class="col-md-2 d-none d-md-block bg-light sidebar">
            <ul class="nav flex-column">
                {{#each sibling_modules}}
                <li class="nav-item">
                    <a class="nav-link active" href="{{sibling_link this}}">{{this}}</a>
                </li> 
                {{/each}}
            </ul>
        </nav>

        <main class="col-md-9 ml-sm-auto cl-lg-10 pt-3 px-4" role="main">
            <div class="row pb-3 mb-4 border-bottom">
                <h1 class="col-md-10">{{name}}</h1>
                {{#if @root.src_url}}
                <div class="col-md-2">
                    <a class="float-right" href="{{@root.src_url}}/{{symbol_to_path name}}.glu">[src]</a>
                </div>
                {{/if}}
            </div>

            {{#if sub_modules}}
            <h2>Modules</h2>

            <table class="table-sm">
            <tbody>
            {{#each sub_modules}}
                <tr>
                    <td>
                        <a href="{{module_link name}}">{{name}}</a>
                    </td>
                    <td valign="middle">
                        {{markdown_first_paragraph comment}}
                    </td>
                </tr>
            {{/each}}
            </table>
            {{/if}}

            <div class="docblock">{{markdown comment}}</div>

            {{#if record.types}}
            <h2 class="pb-3 mb-4 border-bottom"><a class="anchor field" id="Types" href="#Types">Types</a></h2>
            {{#each record.types}}

                <div class="row">
                    <div class="col-md-10">
                        <h4>
                            <pre>{{attributes}}type <a id="type.{{name}}" href="#type.{{name}}">{{name}}</a>{{#each args}} {{name}}{{/each}} = {{{type~}}}
                            </pre>
                        </h4>
                    </div>

                    {{#if @root.src_url}}
                    {{#if definition_line}}
                    <div class="col-md-2">
                        <a class="float-right" href="{{@root.src_url}}/{{symbol_to_path @root.name}}.glu#L{{definition_line}}">[src]</a>
                    </div>
                    {{/if}}
                    {{/if}}
                </div>
                <div class="docblock">{{markdown comment}}</div>

            {{/each}}
            {{/if}}

            {{#if record.values}}
            <h2 class="pb-3 mb-4 border-bottom"><a class="anchor field" id="Values" href="#Values">Values</a></h2>
            {{#each record.values}}

                <div class="row">
                    <div class="col-md-10">
                        <h4>
                        <pre>{{attributes}}let <a class="anchor field" id="value.{{name}}" href="#value.{{name}}">{{name}}</a>
                            {{~#each args~}}
                                {{~#if implicit}} ?{{name}}{{else}} {{name}}{{~/if~}}
                            {{~/each}} : {{{type~}}}
                        </pre>
                        </h4>
                    </div>

                    {{#if @root.src_url}}
                    {{#if definition_line}}
                    <div class="col-md-2">
                        <a class="float-right" href="{{@root.src_url}}/{{symbol_to_path @root.name}}.glu#L{{definition_line}}">[src]</a>
                    </div>
                    {{/if}}
                    {{/if}}
                </div>
                <div class="docblock">{{markdown comment}}</div>

            {{/each}}
            {{/if}}
        </main>

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