Skip to content

Commit 1fbf68d

Browse files
felixmulderfelixmulder
committed
Make sidebar an include instead of a layout
1 parent 3e414ed commit 1fbf68d

File tree

5 files changed

+214
-217
lines changed

5 files changed

+214
-217
lines changed

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<div class="index-wrapper">
2+
{% include "toc" %}
3+
<ul class="index-entities">
4+
{% if docs.size > 0 %}
5+
<li class="index-title">
6+
<span>API</span>
7+
</li>
8+
{% endif %}
9+
{% for pkg in docs %}
10+
<li class="index-entity entity-package">
11+
<a class="entity-name" href="{{ site.baseurl }}/api/{{ pkg.path | join: "/" }}/index.html">{{ pkg.name }}</a>
12+
</li>
13+
{% for member in pkg.children %}
14+
{% if member.kind == "object" and member.hasCompanion %}
15+
{% elsif member.kind != "package" %}
16+
<li class="index-entity {% if member.hasCompanion %} with-companion {% endif %}">
17+
<div class="entity-kinds">
18+
{% if member.hasCompanion %}
19+
<a class="letter-anchor object" href="{{ site.baseurl }}/api/{{ member.companionPath | join: "/" }}.html">O</a>
20+
{% endif %}
21+
<a class="letter-anchor {{ member.kind }}" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.kind | first | capitalize }}</a>
22+
</div>
23+
<a class="entity-name" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
24+
</li>
25+
{% endif %}
26+
{% endfor %}
27+
{% endfor %}
28+
</ul>
29+
</div>
30+
<script>
31+
function toggleMenu() {
32+
var wrapper = document.getElementById("content-wrapper");
33+
wrapper.classList.toggle("toggled");
34+
}
35+
</script>

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

Lines changed: 176 additions & 162 deletions
Original file line numberDiff line numberDiff line change
@@ -1,184 +1,198 @@
11
---
2-
layout: sidebar
2+
layout: main
33
extraCSS:
44
- css/api-page.css
55
---
66

7-
<script>
8-
document.title = "{{ site.project }} API - {{ entity.name }}"
9-
</script>
10-
11-
<div id="entity-container">
12-
<div id="entity-title">
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 %}
26-
<span id="entity-type-params">
27-
<span class="no-left">[</span>
28-
{% for param in entity.typeParams %}
29-
<span class="no-left">
30-
{% if forloop.last %}
31-
{{ param }}
32-
{% else %}
33-
{{ param }},
34-
{% endif %}
35-
</span>
36-
{% endfor %}
37-
<span class="no-left">]</span>
38-
</span>
39-
{% endif %}
40-
{% if entity.superTypes.size > 0 %}
41-
<div id="super-types">
42-
{% for super in entity.superTypes %}
43-
{% if forloop.first %}
44-
<span class="keyword">extends</span>
45-
{% else %}
46-
<span class="keyword">with</span>
47-
{% endif %}
48-
<span class="entity-super-type">{% renderLink super %}</span>
49-
{% endfor %}
50-
</div>
51-
{% endif %}
52-
</div>
7+
<div id="content-wrapper">
8+
{% include "sidebar" %}
539

54-
{% if entity.comment.body %}
55-
<div id="entity-body" class="entity-section">
56-
{{ entity.comment.body }}
57-
</div>
58-
{% endif %}
59-
60-
<h1 class="section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
61-
Constructors
62-
</h1>
63-
64-
<div id="entity-constructors" class="entity-section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
65-
{% for constructor in entity.constructors %}
66-
{% for plist in constructor %}
67-
<div class="member">
68-
<div class="member-title">
69-
<span class="member-name">{{ entity.name }}</span>
70-
<span class="no-left">(</span>
71-
{% if plist.isImplicit %}
72-
<span class="no-left keyword">implicit</span>
73-
{% endif %}
74-
{% for namedRef in plist.list %}
75-
<span class="{% if forloop.first %}no-left{% endif %}">
76-
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
77-
</span>
78-
{% renderRef namedRef.ref %}
79-
{% if forloop.last != true %}
80-
<span class="no-left">, </span>
81-
{% endif %}
82-
{% endfor %}
83-
<span class="no-left">)</span>
84-
</div>
85-
</div>
86-
{% endfor %}
87-
{% endfor %}
88-
</div>
10+
<script>
11+
document.title = "{{ site.project }} API - {{ entity.name }}"
12+
</script>
8913

90-
<h1 class="section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
91-
Members
92-
</h1>
93-
94-
<div id="entity-members" class="entity-section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
95-
{% for member in entity.members %}
96-
<div id="{{ member.signature }}" class="member {% if member.isPrivate %}private{% elsif member.isProtected %}protected{% endif %}">
97-
<div class="member-title">
98-
<span class="expand-button {% if member.hasShortenedDocstring == false %}invisible{% endif %}" onclick="toggleMemberBody(this, '{{ member.signature }}');">[+]</span>
99-
<span class="member-annotations">
100-
{% for annot in member.annotations %}@{{ annot | split: '.' | last }} {% endfor %}
14+
<div id="content-body">
15+
<button type="button" id="menu-toggle" onclick="toggleMenu()" aria-expanded="false">
16+
<span class="sr-only" aria-hidden="true">Toggle navigation</span>
17+
<span class="icon-bar"></span>
18+
<span class="icon-bar"></span>
19+
<span class="icon-bar"></span>
20+
</button>
21+
22+
<div id="entity-container">
23+
<div id="entity-title">
24+
<span id="entity-annotations">
25+
{% for annot in entity.annotations %}@{{ annot | split: '.' | last }} {% endfor %}
10126
</span>
102-
<span class="member-modifiers">
103-
{{ member.modifiers | join: " " }}
27+
<span id="entity-modifiers">
28+
{{ entity.modifiers | join: " " }}
10429
</span>
105-
<span class="member-kind">
106-
{{ member.kind }}
30+
<span id="entity-kind">
31+
{{ entity.kind }}
10732
</span>
108-
<span class="member-name {% if member.isImplicitlyAddedFrom != null %}implicitly-added{% endif %}">
109-
{% if member.kind == "class" or member.kind == "case class" or member.kind == "object" or member.kind == "trait" %}
110-
<a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
111-
{% elsif member.kind == "package" %}
112-
<a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}/index.html">{{ member.name }}</a>
113-
{% else %}
114-
{{ member.name }}
115-
{% endif %}
33+
<span id="entity-name">
34+
{{ entity.name }}
11635
</span>
117-
118-
{% if member.kind == "def" and member.paramLists.size > 0 %}
119-
{% for plist in member.paramLists %}
120-
<span class="no-left">(</span>
121-
{% if plist.isImplicit %}
122-
<span class="no-left keyword">implicit</span>
36+
{% if entity.typeParams.size > 0 %}
37+
<span id="entity-type-params">
38+
<span class="no-left">[</span>
39+
{% for param in entity.typeParams %}
40+
<span class="no-left">
41+
{% if forloop.last %}
42+
{{ param }}
43+
{% else %}
44+
{{ param }},
12345
{% endif %}
124-
{% for namedRef in plist.list %}
125-
<span class="{% if forloop.first %}no-left{% endif %}">
126-
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
127-
</span>
128-
{% renderRef namedRef.ref %}
129-
{% if forloop.last != true %}
130-
<span class="no-left">, </span>
131-
{% endif %}
132-
{% endfor %}
133-
<span class="no-left">)</span>
46+
</span>
13447
{% endfor %}
48+
<span class="no-left">]</span>
49+
</span>
13550
{% endif %}
136-
137-
{% if member.kind == "type" %}
138-
{% for tparam in member.typeParams %}
51+
{% if entity.superTypes.size > 0 %}
52+
<div id="super-types">
53+
{% for super in entity.superTypes %}
13954
{% if forloop.first %}
140-
<span class="no-left">[</span>
141-
{% endif %}
142-
{% if forloop.last %}
143-
<span class="no-left">{{ tparam }}</span>
144-
<span class="no-left">]</span>
55+
<span class="keyword">extends</span>
14556
{% else %}
146-
<span class="no-left">{{ tparam }}, </span>
57+
<span class="keyword">with</span>
14758
{% endif %}
148-
{% endfor %}
149-
{% if member.alias != null %}
150-
<span class="type-alias">
151-
<span class="equals"> = </span>
152-
{% renderRef member.alias %}
153-
</span>
154-
{% endif %}
59+
<span class="entity-super-type">{% renderLink super %}</span>
60+
{% endfor %}
61+
</div>
15562
{% endif %}
63+
</div>
15664

157-
{% if member.returnValue %}
158-
<span class="no-left">: {% renderRef member.returnValue %}</span>
159-
{% endif %}
160-
</div><!-- end member-title -->
65+
{% if entity.comment.body %}
66+
<div id="entity-body" class="entity-section">
67+
{{ entity.comment.body }}
68+
</div>
69+
{% endif %}
16170

162-
<div class="member-body">
163-
<div class="member-body-short" id="short-body-{{ member.signature }}">
164-
{{ member.comment.short }}
165-
</div>
166-
<div class="member-body-long" id ="long-body-{{ member.signature }}">
167-
{{ member.comment.body }}
168-
</div>
71+
<h1 class="section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
72+
Constructors
73+
</h1>
74+
75+
<div id="entity-constructors" class="entity-section {% if entity.constructors == null or entity.constructors.size == 0 %}empty{% endif %}">
76+
{% for constructor in entity.constructors %}
77+
{% for plist in constructor %}
78+
<div class="member">
79+
<div class="member-title">
80+
<span class="member-name">{{ entity.name }}</span>
81+
<span class="no-left">(</span>
82+
{% if plist.isImplicit %}
83+
<span class="no-left keyword">implicit</span>
84+
{% endif %}
85+
{% for namedRef in plist.list %}
86+
<span class="{% if forloop.first %}no-left{% endif %}">
87+
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
88+
</span>
89+
{% renderRef namedRef.ref %}
90+
{% if forloop.last != true %}
91+
<span class="no-left">, </span>
92+
{% endif %}
93+
{% endfor %}
94+
<span class="no-left">)</span>
95+
</div>
96+
</div>
97+
{% endfor %}
98+
{% endfor %}
99+
</div>
100+
101+
<h1 class="section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
102+
Members
103+
</h1>
104+
105+
<div id="entity-members" class="entity-section {% if entity.hasVisibleMembers == false %}empty{% endif %}">
106+
{% for member in entity.members %}
107+
<div id="{{ member.signature }}" class="member {% if member.isPrivate %}private{% elsif member.isProtected %}protected{% endif %}">
108+
<div class="member-title">
109+
<span class="expand-button {% if member.hasShortenedDocstring == false %}invisible{% endif %}" onclick="toggleMemberBody(this, '{{ member.signature }}');">[+]</span>
110+
<span class="member-annotations">
111+
{% for annot in member.annotations %}@{{ annot | split: '.' | last }} {% endfor %}
112+
</span>
113+
<span class="member-modifiers">
114+
{{ member.modifiers | join: " " }}
115+
</span>
116+
<span class="member-kind">
117+
{{ member.kind }}
118+
</span>
119+
<span class="member-name {% if member.isImplicitlyAddedFrom != null %}implicitly-added{% endif %}">
120+
{% if member.kind == "class" or member.kind == "case class" or member.kind == "object" or member.kind == "trait" %}
121+
<a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
122+
{% elsif member.kind == "package" %}
123+
<a href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}/index.html">{{ member.name }}</a>
124+
{% else %}
125+
{{ member.name }}
126+
{% endif %}
127+
</span>
128+
129+
{% if member.kind == "def" and member.paramLists.size > 0 %}
130+
{% for plist in member.paramLists %}
131+
<span class="no-left">(</span>
132+
{% if plist.isImplicit %}
133+
<span class="no-left keyword">implicit</span>
134+
{% endif %}
135+
{% for namedRef in plist.list %}
136+
<span class="{% if forloop.first %}no-left{% endif %}">
137+
{{ namedRef.title }}:{% if namedRef.isByName %} =&gt;{% endif %}
138+
</span>
139+
{% renderRef namedRef.ref %}
140+
{% if forloop.last != true %}
141+
<span class="no-left">, </span>
142+
{% endif %}
143+
{% endfor %}
144+
<span class="no-left">)</span>
145+
{% endfor %}
146+
{% endif %}
147+
148+
{% if member.kind == "type" %}
149+
{% for tparam in member.typeParams %}
150+
{% if forloop.first %}
151+
<span class="no-left">[</span>
152+
{% endif %}
153+
{% if forloop.last %}
154+
<span class="no-left">{{ tparam }}</span>
155+
<span class="no-left">]</span>
156+
{% else %}
157+
<span class="no-left">{{ tparam }}, </span>
158+
{% endif %}
159+
{% endfor %}
160+
{% if member.alias != null %}
161+
<span class="type-alias">
162+
<span class="equals"> = </span>
163+
{% renderRef member.alias %}
164+
</span>
165+
{% endif %}
166+
{% endif %}
167+
168+
{% if member.returnValue %}
169+
<span class="no-left">: {% renderRef member.returnValue %}</span>
170+
{% endif %}
171+
</div><!-- end member-title -->
172+
173+
<div class="member-body">
174+
<div class="member-body-short" id="short-body-{{ member.signature }}">
175+
{{ member.comment.short }}
176+
</div>
177+
<div class="member-body-long" id ="long-body-{{ member.signature }}">
178+
{{ member.comment.body }}
179+
</div>
180+
</div>
181+
<script>
182+
function toggleMemberBody(span, sig) {
183+
var shortBody = document.getElementById("short-body-" + sig);
184+
var longBody = document.getElementById("long-body-" + sig);
185+
186+
shortBody.classList.toggle("toggled")
187+
longBody.classList.toggle("toggled")
188+
189+
span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]";
190+
}
191+
</script>
192+
</div><!-- end member -->
193+
{% endfor %}
169194
</div>
170-
<script>
171-
function toggleMemberBody(span, sig) {
172-
var shortBody = document.getElementById("short-body-" + sig);
173-
var longBody = document.getElementById("long-body-" + sig);
174-
175-
shortBody.classList.toggle("toggled")
176-
longBody.classList.toggle("toggled")
177-
178-
span.innerHTML = (span.innerHTML == "[+]") ? "[-]" : "[+]";
179-
}
180-
</script>
181-
</div><!-- end member -->
182-
{% endfor %}
195+
</div><!-- end entity-container -->
183196
</div>
184-
</div><!-- end entity-container -->
197+
198+
</div><!-- end content-wrapper -->

0 commit comments

Comments
 (0)