Skip to content

Commit df2136c

Browse files
TheElectronWillTheElectronWill
committed
Fix the layout of index.html
It makes sense to keep the main layout as it is to avoid redondant code, but index.html doesn't want a toolbar nor a sidebar. I've therefore created a "base" layout inherited by main.
1 parent c250813 commit df2136c

File tree

7 files changed

+198
-219
lines changed

7 files changed

+198
-219
lines changed

‎doc-tool/resources/_includes/sidebar.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,4 +43,3 @@
4343
{% endif %}
4444
</ul>
4545
</nav>
46-
<script src="{{ site.baseurl }}/js/sidebar.js"></script>

‎doc-tool/resources/_includes/toolbar.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,3 @@ <h2>{{ site.version }}</h2>
3737
{% endif %}
3838
</nav>
3939
</header>
40-
<script src="{{ site.baseurl }}/js/toolbar.js"></script>

‎doc-tool/resources/_layouts/api-page.html

Lines changed: 142 additions & 144 deletions
Original file line numberDiff line numberDiff line change
@@ -8,180 +8,178 @@
88
document.title = "{{ site.project }} Docs - {{ entity.name }}"
99
</script>
1010

11-
<main>
12-
<div id="entity-container">
13-
<div id="entity-title">
14-
<span id="entity-annotations">
15-
{% for annot in entity.annotations %}@{{ annot | split: '.' | last }} {% endfor %}
16-
</span>
17-
<span id="entity-modifiers">
18-
{{ entity.modifiers | join: " " }}
19-
</span>
20-
<span id="entity-kind">
21-
{{ entity.kind }}
22-
</span>
23-
<span id="entity-name">
24-
{{ entity.name }}
25-
</span>
26-
{% if entity.typeParams.size > 0 %}
11+
<main class="container">
12+
<header>
13+
<span id="entity-annotations">
14+
{% for annot in entity.annotations %}@{{ annot | split: '.' | last }} {% endfor %}
15+
</span>
16+
<span id="entity-modifiers">
17+
{{ entity.modifiers | join: " " }}
18+
</span>
19+
<span id="entity-kind">
20+
{{ entity.kind }}
21+
</span>
22+
<span id="entity-name">
23+
{{ entity.name }}
24+
</span>
25+
{% if entity.typeParams.size > 0 %}
2726
<span id="entity-type-params">
2827
<span class="no-left">[</span>
2928
{% for param in entity.typeParams %}
30-
<span class="no-left">
31-
{% if forloop.last %}
32-
{{ param }}
33-
{% else %}
34-
{{ param }},
35-
{% endif %}
36-
</span>
29+
<span class="no-left">
30+
{% if forloop.last %}
31+
{{ param }}
32+
{% else %}
33+
{{ param }},
34+
{% endif %}
35+
</span>
3736
{% endfor %}
3837
<span class="no-left">]</span>
3938
</span>
40-
{% endif %}
41-
{% if entity.superTypes.size > 0 %}
42-
<div id="super-types">
43-
{% for super in entity.superTypes %}
39+
{% endif %}
40+
{% if entity.superTypes.size > 0 %}
41+
<div id="super-types">
42+
{% for super in entity.superTypes %}
4443
{% if forloop.first %}
45-
<span class="keyword">extends</span>
44+
<span class="keyword">extends</span>
4645
{% else %}
47-
<span class="keyword">with</span>
46+
<span class="keyword">with</span>
4847
{% endif %}
4948
<span class="entity-super-type">{% renderLink super %}</span>
50-
{% endfor %}
51-
</div>
52-
{% endif %}
49+
{% endfor %}
5350
</div>
51+
{% endif %}
52+
</header>
5453

55-
{% if entity.comment.body %}
54+
{% if entity.comment.body %}
5655
<div id="entity-body" class="entity-section">
5756
{{ entity.comment.body }}
5857
</div>
59-
{% endif %}
58+
{% endif %}
6059

61-
<h1 class="section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
62-
<span class="expand-button visible{% if entity.constructors == null or entity.constructors.size == 0 %}invisible{% endif %}" onclick="toggleMembersBody(this, 'constructors');">[-]</span>
63-
Constructors
64-
</h1>
60+
<h1 class="section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
61+
<span class="expand-button visible{% if entity.constructors == null or entity.constructors.size == 0 %}invisible{% endif %}" onclick="toggleMembersBody(this, 'constructors');">[-]</span>
62+
Constructors
63+
</h1>
6564

66-
<div id="entity-constructors" class="entity-section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
67-
{% for constructor in entity.constructors %}
68-
{% for plist in constructor %}
69-
<div class="member">
70-
<div class="member-title">
71-
<span class="member-name">{{ entity.name }}</span>
72-
<span class="no-left">(</span>
73-
{% if plist.isImplicit %}
74-
<span class="no-left keyword">implicit</span>
65+
<div id="entity-constructors" class="entity-section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
66+
{% for constructor in entity.constructors %}
67+
{% for plist in constructor %}
68+
<div class="member">
69+
<div class="member-title">
70+
<span class="member-name">{{ entity.name }}</span>
71+
<span class="no-left">(</span>
72+
{% if plist.isImplicit %}
73+
<span class="no-left keyword">implicit</span>
74+
{% endif %}
75+
{% for namedRef in plist.list %}
76+
<span class="{% if forloop.first %}no-left{% endif %}">
77+
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
78+
</span>
79+
{% renderRef namedRef.ref %}
80+
{% if forloop.last != true %}
81+
<span class="no-left">, </span>
7582
{% endif %}
76-
{% for namedRef in plist.list %}
77-
<span class="{% if forloop.first %}no-left{% endif %}">
78-
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
79-
</span>
80-
{% renderRef namedRef.ref %}
81-
{% if forloop.last != true %}
82-
<span class="no-left">, </span>
83-
{% endif %}
84-
{% endfor %}
85-
<span class="no-left">)</span>
86-
</div>
83+
{% endfor %}
84+
<span class="no-left">)</span>
8785
</div>
88-
{% endfor %}
86+
</div>
8987
{% endfor %}
90-
</div>
88+
{% endfor %}
89+
</div>
9190

92-
<h1 class="section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
93-
<span class="expand-button visible" onclick="toggleMembersBody(this, 'members');">[-]</span>
94-
Members
95-
</h1>
96-
97-
<div id="entity-members" class="entity-section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
98-
{% for member in entity.members %}
99-
<div id="{{ member.signature }}" class="member {% if member.isPrivate %}private{% elsif member.isProtected %}protected{% endif %}">
100-
<div class="member-title">
101-
<span class="expand-button {% if member.comment.body %}visible{% endif %}" onclick="toggleMemberBody(this, '{{ member.signature }}');">[+]</span>
102-
<span class="member-annotations">
103-
{% for annot in member.annotations %}@{{ annot | split: '.' | last }} {% endfor %}
104-
</span>
105-
<span class="member-modifiers">
106-
{{ member.modifiers | join: " " }}
107-
</span>
108-
<span class="member-kind">
109-
{{ member.kind }}
110-
</span>
111-
<span class="member-name {% if member.isImplicitlyAddedFrom != null %}implicitly-added{% endif %}">
112-
{% if member.kind == "class" or member.kind == "case class" or member.kind == "object" or member.kind == "trait" %}
113-
<a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
114-
{% elsif member.kind == "package" %}
115-
<a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}/index.html">{{ member.name }}</a>
116-
{% else %}
117-
{{ member.name }}
118-
{% endif %}
119-
</span>
91+
<h1 class="section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
92+
<span class="expand-button visible" onclick="toggleMembersBody(this, 'members');">[-]</span>
93+
Members
94+
</h1>
12095

121-
{% if member.kind == "def" and member.paramLists.size > 0 %}
122-
{% for plist in member.paramLists %}
123-
<span class="no-left">(</span>
124-
{% if plist.isImplicit %}
125-
<span class="no-left keyword">implicit</span>
126-
{% endif %}
127-
{% for namedRef in plist.list %}
128-
<span class="{% if forloop.first %}no-left{% endif %}">
129-
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
130-
</span>
131-
{% renderRef namedRef.ref %}
132-
{% if forloop.last != true %}
133-
<span class="no-left">, </span>
134-
{% endif %}
135-
{% endfor %}
136-
<span class="no-left">)</span>
137-
{% endfor %}
96+
<div id="entity-members" class="entity-section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
97+
{% for member in entity.members %}
98+
<div id="{{ member.signature }}" class="member {% if member.isPrivate %}private{% elsif member.isProtected %}protected{% endif %}">
99+
<div class="member-title">
100+
<span class="expand-button {% if member.comment.body %}visible{% endif %}" onclick="toggleMemberBody(this, '{{ member.signature }}');">[+]</span>
101+
<span class="member-annotations">
102+
{% for annot in member.annotations %}@{{ annot | split: '.' | last }} {% endfor %}
103+
</span>
104+
<span class="member-modifiers">
105+
{{ member.modifiers | join: " " }}
106+
</span>
107+
<span class="member-kind">
108+
{{ member.kind }}
109+
</span>
110+
<span class="member-name {% if member.isImplicitlyAddedFrom != null %}implicitly-added{% endif %}">
111+
{% if member.kind == "class" or member.kind == "case class" or member.kind == "object" or member.kind == "trait" %}
112+
<a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
113+
{% elsif member.kind == "package" %}
114+
<a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}/index.html">{{ member.name }}</a>
115+
{% else %}
116+
{{ member.name }}
138117
{% endif %}
118+
</span>
139119

140-
{% if member.kind == "type" %}
141-
{% for tparam in member.typeParams %}
142-
{% if forloop.first %}
143-
<span class="no-left">[</span>
144-
{% endif %}
145-
{% if forloop.last %}
146-
<span class="no-left">{{ tparam }}</span>
147-
<span class="no-left">]</span>
148-
{% else %}
149-
<span class="no-left">{{ tparam }}, </span>
120+
{% if member.kind == "def" and member.paramLists.size > 0 %}
121+
{% for plist in member.paramLists %}
122+
<span class="no-left">(</span>
123+
{% if plist.isImplicit %}
124+
<span class="no-left keyword">implicit</span>
150125
{% endif %}
126+
{% for namedRef in plist.list %}
127+
<span class="{% if forloop.first %}no-left{% endif %}">
128+
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
129+
</span>
130+
{% renderRef namedRef.ref %}
131+
{% if forloop.last != true %}
132+
<span class="no-left">, </span>
133+
{% endif %}
134+
{% endfor %}
135+
<span class="no-left">)</span>
151136
{% endfor %}
152-
{% if member.alias != null %}
153-
<span class="type-alias">
154-
<span class="equals"> = </span>
155-
{% renderRef member.alias %}
156-
</span>
137+
{% endif %}
138+
139+
{% if member.kind == "type" %}
140+
{% for tparam in member.typeParams %}
141+
{% if forloop.first %}
142+
<span class="no-left">[</span>
157143
{% endif %}
144+
{% if forloop.last %}
145+
<span class="no-left">{{ tparam }}</span>
146+
<span class="no-left">]</span>
147+
{% else %}
148+
<span class="no-left">{{ tparam }}, </span>
158149
{% endif %}
150+
{% endfor %}
151+
{% if member.alias != null %}
152+
<span class="type-alias">
153+
<span class="equals"> = </span>
154+
{% renderRef member.alias %}
155+
</span>
156+
{% endif %}
157+
{% endif %}
159158

160-
{% if member.returnValue %}
161-
<span class="no-left">: {% renderRef member.returnValue %}</span>
162-
{% endif %}
163-
</div><!-- end member-title -->
159+
{% if member.returnValue %}
160+
<span class="no-left">: {% renderRef member.returnValue %}</span>
161+
{% endif %}
162+
</div><!-- end member-title -->
164163

165-
<div class="member-body">
166-
<div class="member-body-long" id ="long-body-{{ member.signature }}">
167-
{{ member.comment.body }}
168-
</div>
164+
<div class="member-body">
165+
<div class="member-body-long" id ="long-body-{{ member.signature }}">
166+
{{ member.comment.body }}
169167
</div>
170-
</div><!-- end member -->
171-
{% endfor %}
172-
<script>
173-
function toggleMembersBody(span, arg){
174-
var members = document.getElementById("entity-" + arg);
175-
members.classList.toggle("toggled");
176-
span.innerHTML = (span.innerHTML == "[-]") ? "[+]" : "[-]";
177-
}
168+
</div>
169+
</div><!-- end member -->
170+
{% endfor %}
171+
<script>
172+
function toggleMembersBody(span, arg){
173+
var members = document.getElementById("entity-" + arg);
174+
members.classList.toggle("toggled");
175+
span.innerHTML = (span.innerHTML == "[-]") ? "[+]" : "[-]";
176+
}
178177

179-
function toggleMemberBody(span, sig) {
180-
var longBody = document.getElementById("long-body-" + sig);
181-
longBody.classList.toggle("toggled")
182-
span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]";
183-
}
184-
</script>
185-
</div>
186-
</div><!-- end entity-container -->
178+
function toggleMemberBody(span, sig) {
179+
var longBody = document.getElementById("long-body-" + sig);
180+
longBody.classList.toggle("toggled")
181+
span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]";
182+
}
183+
</script>
184+
</div>
187185
</main>

‎doc-tool/resources/_layouts/base.html

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<!-- This page was last generated on {{ page.date | date: "%Y-%m-%d" }} -->
2+
<!DOCTYPE html>
3+
<html lang="en">
4+
<head>
5+
<meta charset="utf-8">
6+
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
7+
<meta http-equiv="x-ua-compatible" content="ie=edge">
8+
9+
<title>{{ page.title }}</title>
10+
11+
<link rel="icon" type="image/png" href="{{ site.baseurl }}/images/favicon.png">
12+
13+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.9.0/css/all.min.css">
14+
<link rel="stylesheet" href="{{ site.baseurl }}/css/bootstrap.min.css">
15+
<link rel="stylesheet" href="{{ site.baseurl }}/css/dottydoc.css">
16+
<link rel="stylesheet" href="{{ site.baseurl }}/css/color-brewer.css"><!-- hljs theme -->
17+
18+
{% for css in page.extraCSS %}
19+
<link rel="stylesheet" href="{{ site.baseurl }}/{{ css }}">
20+
{% endfor %}
21+
22+
<script src="{{ site.baseurl }}/js/jquery.min.js"></script>
23+
</head>
24+
<body>
25+
{{ content }}
26+
27+
<script src="{{ site.baseurl }}/js/highlight.pack.js"></script>
28+
<script src="{{ site.baseurl }}/js/bootstrap.min.js"></script>
29+
{% for js in page.extraJS %}
30+
<script src="{{ site.baseurl }}/{{ js }}"></script>
31+
{% endfor %}
32+
<script src="{{ site.baseurl }}/js/dottydoc.js"></script>
33+
<script>
34+
((window.gitter = {}).chat = {}).options = {
35+
room: 'lampepfl/dotty'
36+
};
37+
</script>
38+
<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>
39+
</body>
40+
</html>

0 commit comments

Comments
 (0)