rdoc 6.16.1 → 7.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CONTRIBUTING.md +196 -0
- data/LEGAL.rdoc +6 -0
- data/README.md +90 -7
- data/doc/markup_reference/markdown.md +558 -0
- data/doc/markup_reference/rdoc.rdoc +1169 -0
- data/lib/rdoc/code_object/any_method.rb +15 -7
- data/lib/rdoc/code_object/class_module.rb +62 -11
- data/lib/rdoc/code_object/constant.rb +9 -0
- data/lib/rdoc/code_object/context/section.rb +20 -1
- data/lib/rdoc/code_object/method_attr.rb +13 -1
- data/lib/rdoc/code_object/top_level.rb +13 -1
- data/lib/rdoc/cross_reference.rb +30 -21
- data/lib/rdoc/generator/aliki.rb +141 -0
- data/lib/rdoc/generator/darkfish.rb +8 -2
- data/lib/rdoc/generator/template/aliki/_footer.rhtml +1 -1
- data/lib/rdoc/generator/template/aliki/_head.rhtml +4 -4
- data/lib/rdoc/generator/template/aliki/_header.rhtml +4 -4
- data/lib/rdoc/generator/template/aliki/_icons.rhtml +208 -0
- data/lib/rdoc/generator/template/aliki/_sidebar_ancestors.rhtml +12 -2
- data/lib/rdoc/generator/template/aliki/_sidebar_classes.rhtml +12 -2
- data/lib/rdoc/generator/template/aliki/_sidebar_extends.rhtml +20 -10
- data/lib/rdoc/generator/template/aliki/_sidebar_includes.rhtml +20 -10
- data/lib/rdoc/generator/template/aliki/_sidebar_methods.rhtml +32 -12
- data/lib/rdoc/generator/template/aliki/_sidebar_pages.rhtml +58 -28
- data/lib/rdoc/generator/template/aliki/_sidebar_search.rhtml +3 -3
- data/lib/rdoc/generator/template/aliki/_sidebar_sections.rhtml +16 -6
- data/lib/rdoc/generator/template/aliki/class.rhtml +13 -12
- data/lib/rdoc/generator/template/aliki/css/rdoc.css +401 -50
- data/lib/rdoc/generator/template/aliki/index.rhtml +2 -1
- data/lib/rdoc/generator/template/aliki/js/aliki.js +43 -21
- data/lib/rdoc/generator/template/aliki/js/c_highlighter.js +1 -1
- data/lib/rdoc/generator/template/aliki/js/{search.js → search_controller.js} +15 -6
- data/lib/rdoc/generator/template/aliki/js/search_navigation.js +105 -0
- data/lib/rdoc/generator/template/aliki/js/search_ranker.js +239 -0
- data/lib/rdoc/generator/template/aliki/page.rhtml +2 -1
- data/lib/rdoc/generator/template/aliki/servlet_not_found.rhtml +1 -1
- data/lib/rdoc/generator/template/aliki/servlet_root.rhtml +1 -1
- data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +1 -1
- data/lib/rdoc/generator/template/darkfish/class.rhtml +11 -11
- data/lib/rdoc/generator/template/darkfish/css/rdoc.css +19 -0
- data/lib/rdoc/markdown.kpeg +1 -5
- data/lib/rdoc/markdown.rb +1 -5
- data/lib/rdoc/markup/attribute_manager.rb +28 -1
- data/lib/rdoc/markup/blank_line.rb +25 -23
- data/lib/rdoc/markup/element.rb +21 -0
- data/lib/rdoc/markup/hard_break.rb +30 -27
- data/lib/rdoc/markup/heading.rb +166 -77
- data/lib/rdoc/markup/raw.rb +52 -55
- data/lib/rdoc/markup/table.rb +48 -40
- data/lib/rdoc/markup/to_ansi.rb +4 -0
- data/lib/rdoc/markup/to_bs.rb +4 -0
- data/lib/rdoc/markup/to_html.rb +31 -11
- data/lib/rdoc/markup/to_html_crossref.rb +24 -5
- data/lib/rdoc/markup/to_label.rb +11 -1
- data/lib/rdoc/markup/to_rdoc.rb +11 -3
- data/lib/rdoc/markup/verbatim.rb +1 -1
- data/lib/rdoc/markup.rb +3 -2
- data/lib/rdoc/options.rb +1 -1
- data/lib/rdoc/parser/changelog.rb +8 -0
- data/lib/rdoc/rubygems_hook.rb +3 -3
- data/lib/rdoc/text.rb +15 -0
- data/lib/rdoc/token_stream.rb +4 -8
- data/lib/rdoc/version.rb +1 -1
- data/rdoc.gemspec +3 -3
- metadata +12 -10
- data/CONTRIBUTING.rdoc +0 -219
- data/ExampleMarkdown.md +0 -39
- data/ExampleRDoc.rdoc +0 -210
|
@@ -0,0 +1,208 @@
|
|
|
1
|
+
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
|
2
|
+
<!-- Chevron (right arrow) - used for expand/collapse -->
|
|
3
|
+
<symbol
|
|
4
|
+
id="icon-chevron"
|
|
5
|
+
viewBox="0 0 24 24"
|
|
6
|
+
fill="none"
|
|
7
|
+
stroke="currentColor"
|
|
8
|
+
stroke-width="2"
|
|
9
|
+
stroke-linecap="round"
|
|
10
|
+
stroke-linejoin="round"
|
|
11
|
+
>
|
|
12
|
+
<polyline points="9 18 15 12 9 6"></polyline>
|
|
13
|
+
</symbol>
|
|
14
|
+
|
|
15
|
+
<!-- File/Document - Pages section -->
|
|
16
|
+
<symbol
|
|
17
|
+
id="icon-file"
|
|
18
|
+
viewBox="0 0 24 24"
|
|
19
|
+
fill="none"
|
|
20
|
+
stroke="currentColor"
|
|
21
|
+
stroke-width="2"
|
|
22
|
+
stroke-linecap="round"
|
|
23
|
+
stroke-linejoin="round"
|
|
24
|
+
>
|
|
25
|
+
<path
|
|
26
|
+
d="M14.5 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V7.5L14.5 2z"
|
|
27
|
+
></path>
|
|
28
|
+
|
|
29
|
+
<polyline points="14 2 14 8 20 8"></polyline>
|
|
30
|
+
</symbol>
|
|
31
|
+
|
|
32
|
+
<!-- Layers/Stack - Classes and Modules section -->
|
|
33
|
+
<symbol
|
|
34
|
+
id="icon-layers"
|
|
35
|
+
viewBox="0 0 24 24"
|
|
36
|
+
fill="none"
|
|
37
|
+
stroke="currentColor"
|
|
38
|
+
stroke-width="2"
|
|
39
|
+
stroke-linecap="round"
|
|
40
|
+
stroke-linejoin="round"
|
|
41
|
+
>
|
|
42
|
+
<polygon points="12 2 2 7 12 12 22 7 12 2"></polygon>
|
|
43
|
+
<polyline points="2 17 12 22 22 17"></polyline>
|
|
44
|
+
<polyline points="2 12 12 17 22 12"></polyline>
|
|
45
|
+
</symbol>
|
|
46
|
+
|
|
47
|
+
<!-- Curly braces with C - Class Methods section -->
|
|
48
|
+
<symbol
|
|
49
|
+
id="icon-class-methods"
|
|
50
|
+
viewBox="0 0 24 24"
|
|
51
|
+
fill="none"
|
|
52
|
+
stroke="currentColor"
|
|
53
|
+
stroke-width="2"
|
|
54
|
+
stroke-linecap="round"
|
|
55
|
+
stroke-linejoin="round"
|
|
56
|
+
>
|
|
57
|
+
<path d="M6 3C3.5 3 2 4.5 2 7v3c0 1.5-1 2-1 2s1 .5 1 2v5c0 2.5 1.5 4 4 4"></path>
|
|
58
|
+
<path d="M18 3c2.5 0 4 1.5 4 4v3c0 1.5 1 2 1 2s-1 .5-1 2v5c0 2.5-1.5 4-4 4"></path>
|
|
59
|
+
|
|
60
|
+
<text
|
|
61
|
+
x="12"
|
|
62
|
+
y="17"
|
|
63
|
+
text-anchor="middle"
|
|
64
|
+
font-size="13"
|
|
65
|
+
font-weight="bold"
|
|
66
|
+
fill="currentColor"
|
|
67
|
+
stroke="none"
|
|
68
|
+
>
|
|
69
|
+
C
|
|
70
|
+
</text>
|
|
71
|
+
</symbol>
|
|
72
|
+
|
|
73
|
+
<!-- Curly braces with I - Instance Methods section -->
|
|
74
|
+
<symbol
|
|
75
|
+
id="icon-instance-methods"
|
|
76
|
+
viewBox="0 0 24 24"
|
|
77
|
+
fill="none"
|
|
78
|
+
stroke="currentColor"
|
|
79
|
+
stroke-width="2"
|
|
80
|
+
stroke-linecap="round"
|
|
81
|
+
stroke-linejoin="round"
|
|
82
|
+
>
|
|
83
|
+
<path d="M6 3C3.5 3 2 4.5 2 7v3c0 1.5-1 2-1 2s1 .5 1 2v5c0 2.5 1.5 4 4 4"></path>
|
|
84
|
+
<path d="M18 3c2.5 0 4 1.5 4 4v3c0 1.5 1 2 1 2s-1 .5-1 2v5c0 2.5-1.5 4-4 4"></path>
|
|
85
|
+
|
|
86
|
+
<text
|
|
87
|
+
x="12"
|
|
88
|
+
y="17"
|
|
89
|
+
text-anchor="middle"
|
|
90
|
+
font-size="13"
|
|
91
|
+
font-weight="bold"
|
|
92
|
+
fill="currentColor"
|
|
93
|
+
stroke="none"
|
|
94
|
+
>
|
|
95
|
+
I
|
|
96
|
+
</text>
|
|
97
|
+
</symbol>
|
|
98
|
+
|
|
99
|
+
<!-- Double chevrons up - Ancestors section -->
|
|
100
|
+
<symbol
|
|
101
|
+
id="icon-ancestors"
|
|
102
|
+
viewBox="0 0 24 24"
|
|
103
|
+
fill="none"
|
|
104
|
+
stroke="currentColor"
|
|
105
|
+
stroke-width="2"
|
|
106
|
+
stroke-linecap="round"
|
|
107
|
+
stroke-linejoin="round"
|
|
108
|
+
>
|
|
109
|
+
<polyline points="17 11 12 6 7 11"></polyline>
|
|
110
|
+
<polyline points="17 18 12 13 7 18"></polyline>
|
|
111
|
+
</symbol>
|
|
112
|
+
|
|
113
|
+
<!-- User with plus - Included Modules section -->
|
|
114
|
+
<symbol
|
|
115
|
+
id="icon-includes"
|
|
116
|
+
viewBox="0 0 24 24"
|
|
117
|
+
fill="none"
|
|
118
|
+
stroke="currentColor"
|
|
119
|
+
stroke-width="2"
|
|
120
|
+
stroke-linecap="round"
|
|
121
|
+
stroke-linejoin="round"
|
|
122
|
+
>
|
|
123
|
+
<path d="M16 21v-2a4 4 0 0 0-4-4H5a4 4 0 0 0-4 4v2"></path>
|
|
124
|
+
<circle cx="8.5" cy="7" r="4"></circle>
|
|
125
|
+
|
|
126
|
+
<line
|
|
127
|
+
x1="20"
|
|
128
|
+
y1="8"
|
|
129
|
+
x2="20"
|
|
130
|
+
y2="14"
|
|
131
|
+
></line>
|
|
132
|
+
|
|
133
|
+
<line
|
|
134
|
+
x1="23"
|
|
135
|
+
y1="11"
|
|
136
|
+
x2="17"
|
|
137
|
+
y2="11"
|
|
138
|
+
></line>
|
|
139
|
+
</symbol>
|
|
140
|
+
|
|
141
|
+
<!-- User with check - Extended Modules section -->
|
|
142
|
+
<symbol
|
|
143
|
+
id="icon-extends"
|
|
144
|
+
viewBox="0 0 24 24"
|
|
145
|
+
fill="none"
|
|
146
|
+
stroke="currentColor"
|
|
147
|
+
stroke-width="2"
|
|
148
|
+
stroke-linecap="round"
|
|
149
|
+
stroke-linejoin="round"
|
|
150
|
+
>
|
|
151
|
+
<path d="M16 21v-2a4 4 0 0 0-4-4H5a4 4 0 0 0-4 4v2"></path>
|
|
152
|
+
<circle cx="8.5" cy="7" r="4"></circle>
|
|
153
|
+
<polyline points="17 11 19 13 23 9"></polyline>
|
|
154
|
+
</symbol>
|
|
155
|
+
|
|
156
|
+
<!-- List - Sections section -->
|
|
157
|
+
<symbol
|
|
158
|
+
id="icon-list"
|
|
159
|
+
viewBox="0 0 24 24"
|
|
160
|
+
fill="none"
|
|
161
|
+
stroke="currentColor"
|
|
162
|
+
stroke-width="2"
|
|
163
|
+
stroke-linecap="round"
|
|
164
|
+
stroke-linejoin="round"
|
|
165
|
+
>
|
|
166
|
+
<line
|
|
167
|
+
x1="8"
|
|
168
|
+
y1="6"
|
|
169
|
+
x2="21"
|
|
170
|
+
y2="6"
|
|
171
|
+
></line>
|
|
172
|
+
|
|
173
|
+
<line
|
|
174
|
+
x1="8"
|
|
175
|
+
y1="12"
|
|
176
|
+
x2="21"
|
|
177
|
+
y2="12"
|
|
178
|
+
></line>
|
|
179
|
+
|
|
180
|
+
<line
|
|
181
|
+
x1="8"
|
|
182
|
+
y1="18"
|
|
183
|
+
x2="21"
|
|
184
|
+
y2="18"
|
|
185
|
+
></line>
|
|
186
|
+
|
|
187
|
+
<line
|
|
188
|
+
x1="3"
|
|
189
|
+
y1="6"
|
|
190
|
+
x2="3.01"
|
|
191
|
+
y2="6"
|
|
192
|
+
></line>
|
|
193
|
+
|
|
194
|
+
<line
|
|
195
|
+
x1="3"
|
|
196
|
+
y1="12"
|
|
197
|
+
x2="3.01"
|
|
198
|
+
y2="12"
|
|
199
|
+
></line>
|
|
200
|
+
|
|
201
|
+
<line
|
|
202
|
+
x1="3"
|
|
203
|
+
y1="18"
|
|
204
|
+
x2="3.01"
|
|
205
|
+
y2="18"
|
|
206
|
+
></line>
|
|
207
|
+
</symbol>
|
|
208
|
+
</svg>
|
|
@@ -1,6 +1,16 @@
|
|
|
1
1
|
<%- if klass.type == 'class' && (ancestors = klass.super_classes).any? %>
|
|
2
2
|
<div id="parent-class-section" class="nav-section">
|
|
3
|
-
<
|
|
4
|
-
|
|
3
|
+
<details class="nav-section-collapsible" open>
|
|
4
|
+
<summary class="nav-section-header">
|
|
5
|
+
<span class="nav-section-icon">
|
|
6
|
+
<svg><use href="#icon-ancestors"></use></svg>
|
|
7
|
+
</span>
|
|
8
|
+
<span class="nav-section-title">Ancestors</span>
|
|
9
|
+
<span class="nav-section-chevron">
|
|
10
|
+
<svg><use href="#icon-chevron"></use></svg>
|
|
11
|
+
</span>
|
|
12
|
+
</summary>
|
|
13
|
+
<%= generate_ancestor_list(ancestors, klass) %>
|
|
14
|
+
</details>
|
|
5
15
|
</div>
|
|
6
16
|
<%- end %>
|
|
@@ -1,5 +1,15 @@
|
|
|
1
1
|
<div id="classindex-section" class="nav-section">
|
|
2
|
-
<
|
|
2
|
+
<details class="nav-section-collapsible" open>
|
|
3
|
+
<summary class="nav-section-header">
|
|
4
|
+
<span class="nav-section-icon">
|
|
5
|
+
<svg><use href="#icon-layers"></use></svg>
|
|
6
|
+
</span>
|
|
7
|
+
<span class="nav-section-title">Classes and Modules</span>
|
|
8
|
+
<span class="nav-section-chevron">
|
|
9
|
+
<svg><use href="#icon-chevron"></use></svg>
|
|
10
|
+
</span>
|
|
11
|
+
</summary>
|
|
3
12
|
|
|
4
|
-
|
|
13
|
+
<%= generate_class_index_content(@classes, rel_prefix) %>
|
|
14
|
+
</details>
|
|
5
15
|
</div>
|
|
@@ -1,15 +1,25 @@
|
|
|
1
1
|
<%- unless klass.extends.empty? then %>
|
|
2
2
|
<div id="extends-section" class="nav-section">
|
|
3
|
-
<
|
|
3
|
+
<details class="nav-section-collapsible" open>
|
|
4
|
+
<summary class="nav-section-header">
|
|
5
|
+
<span class="nav-section-icon">
|
|
6
|
+
<svg><use href="#icon-extends"></use></svg>
|
|
7
|
+
</span>
|
|
8
|
+
<span class="nav-section-title">Extended With Modules</span>
|
|
9
|
+
<span class="nav-section-chevron">
|
|
10
|
+
<svg><use href="#icon-chevron"></use></svg>
|
|
11
|
+
</span>
|
|
12
|
+
</summary>
|
|
4
13
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
+
<ul class="nav-list">
|
|
15
|
+
<%- klass.extends.each do |ext| %>
|
|
16
|
+
<%- unless String === ext.module then %>
|
|
17
|
+
<li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a></li>
|
|
18
|
+
<%- else %>
|
|
19
|
+
<li><span class="extend"><%= ext.name %></span></li>
|
|
20
|
+
<%- end %>
|
|
21
|
+
<%- end %>
|
|
22
|
+
</ul>
|
|
23
|
+
</details>
|
|
14
24
|
</div>
|
|
15
25
|
<%- end %>
|
|
@@ -1,15 +1,25 @@
|
|
|
1
1
|
<%- unless klass.includes.empty? then %>
|
|
2
2
|
<div id="includes-section" class="nav-section">
|
|
3
|
-
<
|
|
3
|
+
<details class="nav-section-collapsible" open>
|
|
4
|
+
<summary class="nav-section-header">
|
|
5
|
+
<span class="nav-section-icon">
|
|
6
|
+
<svg><use href="#icon-includes"></use></svg>
|
|
7
|
+
</span>
|
|
8
|
+
<span class="nav-section-title">Included Modules</span>
|
|
9
|
+
<span class="nav-section-chevron">
|
|
10
|
+
<svg><use href="#icon-chevron"></use></svg>
|
|
11
|
+
</span>
|
|
12
|
+
</summary>
|
|
4
13
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
+
<ul class="nav-list">
|
|
15
|
+
<%- klass.includes.each do |inc| %>
|
|
16
|
+
<%- unless String === inc.module then %>
|
|
17
|
+
<li><a class="include" href="<%= klass.aref_to inc.module.path %>"><%= inc.module.full_name %></a></li>
|
|
18
|
+
<%- else %>
|
|
19
|
+
<li><span class="include"><%= inc.name %></span></li>
|
|
20
|
+
<%- end %>
|
|
21
|
+
<%- end %>
|
|
22
|
+
</ul>
|
|
23
|
+
</details>
|
|
14
24
|
</div>
|
|
15
25
|
<%- end %>
|
|
@@ -1,21 +1,41 @@
|
|
|
1
1
|
<% if (class_methods = klass.class_method_list.sort).any? %>
|
|
2
2
|
<div class="nav-section">
|
|
3
|
-
<
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
3
|
+
<details class="nav-section-collapsible" open>
|
|
4
|
+
<summary class="nav-section-header">
|
|
5
|
+
<span class="nav-section-icon">
|
|
6
|
+
<svg><use href="#icon-class-methods"></use></svg>
|
|
7
|
+
</span>
|
|
8
|
+
<span class="nav-section-title">Class Methods</span>
|
|
9
|
+
<span class="nav-section-chevron">
|
|
10
|
+
<svg><use href="#icon-chevron"></use></svg>
|
|
11
|
+
</span>
|
|
12
|
+
</summary>
|
|
13
|
+
<ul class="nav-list" role="directory">
|
|
14
|
+
<%- class_methods.each do |meth| %>
|
|
15
|
+
<li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name -%></a></li>
|
|
16
|
+
<%- end %>
|
|
17
|
+
</ul>
|
|
18
|
+
</details>
|
|
9
19
|
</div>
|
|
10
20
|
<% end %>
|
|
11
21
|
|
|
12
22
|
<% if (instance_methods = klass.instance_methods.sort).any? %>
|
|
13
23
|
<div class="nav-section">
|
|
14
|
-
<
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
24
|
+
<details class="nav-section-collapsible" open>
|
|
25
|
+
<summary class="nav-section-header">
|
|
26
|
+
<span class="nav-section-icon">
|
|
27
|
+
<svg><use href="#icon-instance-methods"></use></svg>
|
|
28
|
+
</span>
|
|
29
|
+
<span class="nav-section-title">Instance Methods</span>
|
|
30
|
+
<span class="nav-section-chevron">
|
|
31
|
+
<svg><use href="#icon-chevron"></use></svg>
|
|
32
|
+
</span>
|
|
33
|
+
</summary>
|
|
34
|
+
<ul class="nav-list" role="directory">
|
|
35
|
+
<%- instance_methods.each do |meth| %>
|
|
36
|
+
<li <%- if meth.calls_super %>class="calls-super" <%- end %>><a href="#<%= meth.aref %>"><%= h meth.name -%></a></li>
|
|
37
|
+
<%- end %>
|
|
38
|
+
</ul>
|
|
39
|
+
</details>
|
|
20
40
|
</div>
|
|
21
41
|
<% end %>
|
|
@@ -1,37 +1,67 @@
|
|
|
1
1
|
<%- simple_files = @files.select { |f| f.text? } %>
|
|
2
|
+
|
|
2
3
|
<%- if defined?(current) && current.respond_to?(:page_name) %>
|
|
3
4
|
<%- dir = current.full_name[%r{\A[^/]+(?=/)}] || current.page_name %>
|
|
4
5
|
<%- end %>
|
|
6
|
+
|
|
5
7
|
<%- unless simple_files.empty? then %>
|
|
6
8
|
<div id="fileindex-section" class="nav-section">
|
|
7
|
-
<
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
<%- files.
|
|
29
|
-
|
|
9
|
+
<details class="nav-section-collapsible" <%= 'open' unless @inside_class_file %>>
|
|
10
|
+
<summary class="nav-section-header">
|
|
11
|
+
<span class="nav-section-icon">
|
|
12
|
+
<svg>
|
|
13
|
+
<use href="#icon-file"></use>
|
|
14
|
+
</svg>
|
|
15
|
+
</span>
|
|
16
|
+
|
|
17
|
+
<span class="nav-section-title">Pages</span>
|
|
18
|
+
|
|
19
|
+
<span class="nav-section-chevron">
|
|
20
|
+
<svg>
|
|
21
|
+
<use href="#icon-chevron"></use>
|
|
22
|
+
</svg>
|
|
23
|
+
</span>
|
|
24
|
+
</summary>
|
|
25
|
+
|
|
26
|
+
<ul class="nav-list">
|
|
27
|
+
<%- grouped_files = simple_files.group_by { |f| f.full_name[%r{\A[^/]+(?=/)}] || f.page_name } %>
|
|
28
|
+
|
|
29
|
+
<%- grouped_files.each do |n, files| %>
|
|
30
|
+
<%- f = files.shift %>
|
|
31
|
+
|
|
32
|
+
<%- if files.empty? %>
|
|
33
|
+
<li>
|
|
34
|
+
<a href="<%= rel_prefix %>/<%= h f.path %>">
|
|
35
|
+
<%= h f.page_name %>
|
|
36
|
+
</a>
|
|
37
|
+
</li>
|
|
38
|
+
<%- next -%>
|
|
30
39
|
<%- end %>
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
40
|
+
|
|
41
|
+
<li>
|
|
42
|
+
<details <%= dir == n ? ' open' : '' %>>
|
|
43
|
+
<summary>
|
|
44
|
+
<% if n == f.page_name %>
|
|
45
|
+
<a href="<%= rel_prefix %>/<%= h f.path %>"><%= h n %></a>
|
|
46
|
+
<% else %>
|
|
47
|
+
<%= h n %>
|
|
48
|
+
<% files.unshift(f) %>
|
|
49
|
+
<% end %>
|
|
50
|
+
</summary>
|
|
51
|
+
|
|
52
|
+
<ul class="link-list">
|
|
53
|
+
<%- files.each do |f| %>
|
|
54
|
+
<li>
|
|
55
|
+
<a href="<%= rel_prefix %>/<%= h f.path %>">
|
|
56
|
+
<%= h f.page_name %>
|
|
57
|
+
</a>
|
|
58
|
+
</li>
|
|
59
|
+
<%- end %>
|
|
60
|
+
</ul>
|
|
61
|
+
</details>
|
|
62
|
+
</li>
|
|
63
|
+
<%- end %>
|
|
64
|
+
</ul>
|
|
65
|
+
</details>
|
|
36
66
|
</div>
|
|
37
67
|
<%- end %>
|
|
@@ -2,14 +2,14 @@
|
|
|
2
2
|
<form action="#" method="get" accept-charset="utf-8">
|
|
3
3
|
<div id="search-field-wrapper">
|
|
4
4
|
<input id="search-field" role="combobox" aria-label="Search"
|
|
5
|
-
aria-autocomplete="list" aria-controls="search-results"
|
|
5
|
+
aria-autocomplete="list" aria-controls="search-results-desktop"
|
|
6
6
|
type="text" name="search" placeholder="Search (/) for a class, method, ..." spellcheck="false"
|
|
7
7
|
autocomplete="off"
|
|
8
8
|
title="Type to search, Up and Down to navigate, Enter to load">
|
|
9
9
|
</div>
|
|
10
10
|
|
|
11
|
-
<ul id="search-results" aria-label="Search Results"
|
|
11
|
+
<ul id="search-results-desktop" aria-label="Search Results"
|
|
12
12
|
aria-busy="false" aria-expanded="false"
|
|
13
|
-
aria-atomic="false" class="initially-hidden"></ul>
|
|
13
|
+
aria-atomic="false" class="initially-hidden search-results"></ul>
|
|
14
14
|
</form>
|
|
15
15
|
</div>
|
|
@@ -1,11 +1,21 @@
|
|
|
1
1
|
<%- unless klass.sections.length == 1 then %>
|
|
2
2
|
<div id="sections-section" class="nav-section">
|
|
3
|
-
<
|
|
3
|
+
<details class="nav-section-collapsible" open>
|
|
4
|
+
<summary class="nav-section-header">
|
|
5
|
+
<span class="nav-section-icon">
|
|
6
|
+
<svg><use href="#icon-list"></use></svg>
|
|
7
|
+
</span>
|
|
8
|
+
<span class="nav-section-title">Sections</span>
|
|
9
|
+
<span class="nav-section-chevron">
|
|
10
|
+
<svg><use href="#icon-chevron"></use></svg>
|
|
11
|
+
</span>
|
|
12
|
+
</summary>
|
|
4
13
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
14
|
+
<ul class="nav-list" role="directory">
|
|
15
|
+
<%- klass.sort_sections.each do |section| %>
|
|
16
|
+
<li><a href="#<%= section.aref %>"><%= h section.title %></a></li>
|
|
17
|
+
<%- end %>
|
|
18
|
+
</ul>
|
|
19
|
+
</details>
|
|
10
20
|
</div>
|
|
11
21
|
<%- end %>
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
<body role="document" class="<%= klass.type %> has-toc">
|
|
2
|
+
<%= render '_icons.rhtml' %>
|
|
2
3
|
<%= render '_header.rhtml' %>
|
|
3
4
|
<%= render '_sidebar_toggle.rhtml' %>
|
|
4
5
|
|
|
5
|
-
<nav id="navigation" role="navigation">
|
|
6
|
+
<nav id="navigation" role="navigation" hidden>
|
|
6
7
|
<%= render '_sidebar_pages.rhtml' %>
|
|
7
8
|
<%= render '_sidebar_sections.rhtml' %>
|
|
8
9
|
<%= render '_sidebar_ancestors.rhtml' %>
|
|
@@ -28,6 +29,7 @@
|
|
|
28
29
|
</ol>
|
|
29
30
|
<% end %>
|
|
30
31
|
|
|
32
|
+
<span id="<%= h klass.legacy_aref %>" class="legacy-anchor"></span>
|
|
31
33
|
<h1 id="<%= h klass.aref %>" class="anchor-link <%= klass.type %>">
|
|
32
34
|
<%= klass.type %> <%= klass.full_name %>
|
|
33
35
|
</h1>
|
|
@@ -37,6 +39,7 @@
|
|
|
37
39
|
</section>
|
|
38
40
|
|
|
39
41
|
<%- klass.each_section do |section, constants, attributes| %>
|
|
42
|
+
<span id="<%= section.legacy_aref %>" class="legacy-anchor"></span>
|
|
40
43
|
<section id="<%= section.aref %>" class="documentation-section anchor-link">
|
|
41
44
|
<%- if section.title then %>
|
|
42
45
|
<header class="documentation-section-title">
|
|
@@ -109,10 +112,10 @@
|
|
|
109
112
|
</section>
|
|
110
113
|
<%- end %>
|
|
111
114
|
|
|
112
|
-
<%- klass.methods_by_type(section).each do |type, visibilities|
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
115
|
+
<%- klass.methods_by_type(section).each do |type, visibilities| %>
|
|
116
|
+
<%- next if visibilities.empty? %>
|
|
117
|
+
<%- visibilities.each do |visibility, methods| %>
|
|
118
|
+
<%- next if methods.empty? %>
|
|
116
119
|
<section id="<%= visibility %>-<%= type %>-<%= section.aref %>-method-details" class="method-section anchor-link">
|
|
117
120
|
<header>
|
|
118
121
|
<h3 id="<%= visibility %>-<%= type %>-methods"><a href="#<%= visibility %>-<%= type %>-methods"><%= visibility.to_s.capitalize %> <%= type.capitalize %> Methods</a></h3>
|
|
@@ -155,15 +158,13 @@
|
|
|
155
158
|
<summary>Source</summary>
|
|
156
159
|
</details>
|
|
157
160
|
</div>
|
|
161
|
+
<div class="method-source-code" id="<%= method.html_name %>-source">
|
|
162
|
+
<pre class="<%= method.source_language %>"><%= method.markup_code %></pre>
|
|
163
|
+
</div>
|
|
158
164
|
<%- end %>
|
|
159
165
|
|
|
160
166
|
<%- unless method.skip_description? then %>
|
|
161
167
|
<div class="method-description">
|
|
162
|
-
<%- if method.token_stream then %>
|
|
163
|
-
<div class="method-source-code" id="<%= method.html_name %>-source">
|
|
164
|
-
<pre class="<%= method.source_language %>" data-language="<%= method.source_language %>"><%= method.markup_code %></pre>
|
|
165
|
-
</div>
|
|
166
|
-
<%- end %>
|
|
167
168
|
<%- if method.mixin_from then %>
|
|
168
169
|
<div class="mixin-from">
|
|
169
170
|
<%= method.singleton ? "Extended" : "Included" %> from <a href="<%= klass.aref_to(method.mixin_from.path) %>"><%= method.mixin_from.full_name %></a>
|
|
@@ -207,8 +208,8 @@
|
|
|
207
208
|
|
|
208
209
|
<%- end %>
|
|
209
210
|
</section>
|
|
210
|
-
<%- end
|
|
211
|
-
|
|
211
|
+
<%- end %>
|
|
212
|
+
<%- end %>
|
|
212
213
|
</section>
|
|
213
214
|
<%- end %>
|
|
214
215
|
</main>
|