rdoc-generator-solarfish 0.0.2
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 +7 -0
- data/.gitignore +13 -0
- data/.rubocop.yml +26 -0
- data/.travis.yml +9 -0
- data/Gemfile +2 -0
- data/LICENSE +21 -0
- data/README.md +175 -0
- data/Rakefile +28 -0
- data/data/rdoc-generator-solarfish/templates/onepage.slim +110 -0
- data/data/rdoc-generator-solarfish/themes/common/fonts/LICENSE +7 -0
- data/data/rdoc-generator-solarfish/themes/common/fonts/LICENSE.Raleway +95 -0
- data/data/rdoc-generator-solarfish/themes/common/fonts/LICENSE.Roboto +201 -0
- data/data/rdoc-generator-solarfish/themes/common/fonts/Raleway-Regular.ttf +0 -0
- data/data/rdoc-generator-solarfish/themes/common/fonts/Raleway-SemiBold.ttf +0 -0
- data/data/rdoc-generator-solarfish/themes/common/fonts/Roboto-Regular.ttf +0 -0
- data/data/rdoc-generator-solarfish/themes/common/syntax/LICENSE +3 -0
- data/data/rdoc-generator-solarfish/themes/common/syntax/LICENSE.onelight +20 -0
- data/data/rdoc-generator-solarfish/themes/common/syntax/onelight.sass +47 -0
- data/data/rdoc-generator-solarfish/themes/light/main.sass +215 -0
- data/data/rdoc-generator-solarfish/themes/light.yml +16 -0
- data/docs/example.rb +142 -0
- data/docs/example_output/Raleway-Regular.ttf +0 -0
- data/docs/example_output/Raleway-SemiBold.ttf +0 -0
- data/docs/example_output/Roboto-Regular.ttf +0 -0
- data/docs/example_output/created.rid +2 -0
- data/docs/example_output/index.html +404 -0
- data/docs/example_output/index.json +428 -0
- data/docs/example_output/main.css +210 -0
- data/docs/example_output/onelight.css +22 -0
- data/lib/rdoc/discover.rb +1 -0
- data/lib/rdoc/generator/doc_loader.rb +315 -0
- data/lib/rdoc/generator/html_writer.rb +35 -0
- data/lib/rdoc/generator/json_writer.rb +16 -0
- data/lib/rdoc/generator/settings.rb +57 -0
- data/lib/rdoc/generator/solarfish.rb +135 -0
- data/lib/rdoc/generator/template_loader.rb +42 -0
- data/lib/rdoc/generator/theme_loader.rb +160 -0
- data/lib/solarfish.rb +2 -0
- data/rdoc-generator-solarfish.gemspec +31 -0
- data/test/test_generator.rb +95 -0
- data/test/test_theme_loader.rb +89 -0
- data/test/themes.rb +213 -0
- metadata +216 -0
@@ -0,0 +1,404 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="UTF-8" />
|
5
|
+
<title>RDoc::Generator::SolarFish Example</title>
|
6
|
+
<style type="text/css">
|
7
|
+
@font-face {
|
8
|
+
font-family: 'RobotoRegular';
|
9
|
+
src: url('Roboto-Regular.ttf');
|
10
|
+
}
|
11
|
+
</style>
|
12
|
+
<style type="text/css">
|
13
|
+
@font-face {
|
14
|
+
font-family: 'RalewayRegular';
|
15
|
+
src: url('Raleway-Regular.ttf');
|
16
|
+
}
|
17
|
+
</style>
|
18
|
+
<style type="text/css">
|
19
|
+
@font-face {
|
20
|
+
font-family: 'RalewaySemiBold';
|
21
|
+
src: url('Raleway-SemiBold.ttf');
|
22
|
+
}
|
23
|
+
</style>
|
24
|
+
<link href="onelight.css" rel="stylesheet" />
|
25
|
+
<link href="main.css" rel="stylesheet" />
|
26
|
+
</head>
|
27
|
+
<body>
|
28
|
+
<header class="mainHeader">
|
29
|
+
RDoc::Generator::SolarFish Example
|
30
|
+
</header>
|
31
|
+
<aside>
|
32
|
+
<details class="tocClassBlock"><summary><span class="label labelClass">class</span><a class="tocClass" href="#Bird">Bird</a></summary>
|
33
|
+
<div class="tocGroupBlock">
|
34
|
+
<a class="tocGroup" href="#Bird::InstanceMethods">Instance Methods</a>
|
35
|
+
</div>
|
36
|
+
</details>
|
37
|
+
<details class="tocClassBlock"><summary><span class="label labelClass">class</span><a class="tocClass" href="#Duck">Duck</a></summary>
|
38
|
+
<div class="tocGroupBlock">
|
39
|
+
<a class="tocGroup" href="#Duck::ExtendedClasses">Extended Classes</a>
|
40
|
+
<a class="tocGroup" href="#Duck::IncludedModules">Included Modules</a>
|
41
|
+
<a class="tocGroup" href="#Duck::Constants">Constants</a>
|
42
|
+
<a class="tocGroup" href="#Duck::ClassMethods">Class Methods</a>
|
43
|
+
<a class="tocGroup" href="#Duck::InstanceAttributes">Instance Attributes</a>
|
44
|
+
<a class="tocGroup" href="#Duck::InstanceMethods">Instance Methods</a>
|
45
|
+
</div>
|
46
|
+
</details>
|
47
|
+
<details class="tocClassBlock"><summary><span class="label labelClass">class</span><a class="tocClass" href="#Object">Object</a></summary>
|
48
|
+
<div class="tocGroupBlock">
|
49
|
+
<a class="tocGroup" href="#Object::Constants">Constants</a>
|
50
|
+
</div>
|
51
|
+
</details>
|
52
|
+
<details class="tocClassBlock"><summary><span class="label labelModule">module</span><a class="tocClass" href="#Waterfowl">Waterfowl</a></summary>
|
53
|
+
<div class="tocGroupBlock">
|
54
|
+
<a class="tocGroup" href="#Waterfowl::InstanceMethods">Instance Methods</a>
|
55
|
+
</div>
|
56
|
+
</details>
|
57
|
+
</aside>
|
58
|
+
<main>
|
59
|
+
<article class="classBlock" id="Bird">
|
60
|
+
<header class="classHeader">
|
61
|
+
<div class="label labelClass">
|
62
|
+
class
|
63
|
+
</div>
|
64
|
+
<span class="className">Bird</span>
|
65
|
+
</header>
|
66
|
+
<div class="classComment">
|
67
|
+
<p>The base class for all birds.</p>
|
68
|
+
</div>
|
69
|
+
<section class="groupBlock" id="Bird::InstanceMethods">
|
70
|
+
<header class="groupHeader">
|
71
|
+
<span class="groupName">Instance Methods</span>
|
72
|
+
</header>
|
73
|
+
<div class="memberBlock" id="Bird::fly">
|
74
|
+
<div class="memberHeader">
|
75
|
+
<div class="label labelInstanceMethod">
|
76
|
+
instance method
|
77
|
+
</div>
|
78
|
+
<div class="label labelPublic">
|
79
|
+
public
|
80
|
+
</div>
|
81
|
+
<span class="memberName">fly</span>
|
82
|
+
</div>
|
83
|
+
<pre class="memberSignature">Bird.fly(symbol, number) -> bool
|
84
|
+
Bird.fly(string, number) -> bool
|
85
|
+
</pre>
|
86
|
+
<div class="memberComment"><p>Fly somewhere.</p>
|
87
|
+
|
88
|
+
<p>Flying is the most critical feature of birds.</p>
|
89
|
+
|
90
|
+
<h1 id="method-i-fly-label-Example">Example<span><a href="#method-i-fly-label-Example">¶</a> <a href="#top">↑</a></span></h1>
|
91
|
+
|
92
|
+
<pre class="ruby"><span class="ruby-identifier">fly</span>(:<span class="ruby-identifier">south</span>, <span class="ruby-value">70</span>)
|
93
|
+
</pre>
|
94
|
+
</div>
|
95
|
+
<details class="memberCode"><summary>Source code</summary><pre><span class="ruby-comment"># File example.rb, line 51</span>
|
96
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">fly</span>(<span class="ruby-identifier">direction</span>, <span class="ruby-identifier">velocity</span>)
|
97
|
+
<span class="ruby-identifier">_fly_impl</span>(<span class="ruby-identifier">direction</span>, <span class="ruby-identifier">velocity</span>)
|
98
|
+
<span class="ruby-keyword">end</span></pre></details>
|
99
|
+
</div>
|
100
|
+
<div class="memberBlock" id="Bird::speak">
|
101
|
+
<div class="memberHeader">
|
102
|
+
<div class="label labelInstanceMethod">
|
103
|
+
instance method
|
104
|
+
</div>
|
105
|
+
<div class="label labelPublic">
|
106
|
+
public
|
107
|
+
</div>
|
108
|
+
<span class="memberName">speak</span>
|
109
|
+
</div>
|
110
|
+
<pre class="memberSignature">speak() { |text| ... }</pre>
|
111
|
+
<div class="memberComment">
|
112
|
+
<p>Produce some noise.</p>
|
113
|
+
</div>
|
114
|
+
<details class="memberCode"><summary>Source code</summary><pre><span class="ruby-comment"># File example.rb, line 32</span>
|
115
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">speak</span> <span class="ruby-comment"># :yields: text</span>
|
116
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-string">'generic tweeting'</span>
|
117
|
+
<span class="ruby-keyword">yield</span> <span class="ruby-string">'tweet'</span>
|
118
|
+
<span class="ruby-keyword">yield</span> <span class="ruby-string">'tweet'</span>
|
119
|
+
<span class="ruby-keyword">end</span></pre></details>
|
120
|
+
</div>
|
121
|
+
</section>
|
122
|
+
</article>
|
123
|
+
<article class="classBlock" id="Duck">
|
124
|
+
<header class="classHeader">
|
125
|
+
<div class="label labelClass">
|
126
|
+
class
|
127
|
+
</div>
|
128
|
+
<span class="className">Duck</span>
|
129
|
+
</header>
|
130
|
+
<div class="classComment"><p>A duck is a <a href="Waterfowl.html">Waterfowl</a> <a
|
131
|
+
href="Bird.html">Bird</a>.</p>
|
132
|
+
|
133
|
+
<p>Features:</p>
|
134
|
+
|
135
|
+
<pre>bird::
|
136
|
+
|
137
|
+
* speak
|
138
|
+
* fly
|
139
|
+
|
140
|
+
waterfowl::
|
141
|
+
|
142
|
+
* swim</pre>
|
143
|
+
</div>
|
144
|
+
<section class="groupBlock" id="Duck::ExtendedClasses">
|
145
|
+
<header class="groupHeader">
|
146
|
+
<span class="groupName">Extended Classes</span>
|
147
|
+
</header>
|
148
|
+
<div class="memberBlock" id="Duck::Animal">
|
149
|
+
<div class="memberHeader">
|
150
|
+
<div class="label labelExtended">
|
151
|
+
extended
|
152
|
+
</div>
|
153
|
+
<span class="memberName">Animal</span>
|
154
|
+
</div>
|
155
|
+
<pre class="memberSignature"></pre>
|
156
|
+
<div class="memberComment">
|
157
|
+
|
158
|
+
</div>
|
159
|
+
</div>
|
160
|
+
</section>
|
161
|
+
<section class="groupBlock" id="Duck::IncludedModules">
|
162
|
+
<header class="groupHeader">
|
163
|
+
<span class="groupName">Included Modules</span>
|
164
|
+
</header>
|
165
|
+
<div class="memberBlock" id="Duck::Waterfowl">
|
166
|
+
<div class="memberHeader">
|
167
|
+
<div class="label labelIncluded">
|
168
|
+
included
|
169
|
+
</div>
|
170
|
+
<span class="memberName">Waterfowl</span>
|
171
|
+
</div>
|
172
|
+
<pre class="memberSignature"></pre>
|
173
|
+
<div class="memberComment">
|
174
|
+
|
175
|
+
</div>
|
176
|
+
</div>
|
177
|
+
</section>
|
178
|
+
<section class="groupBlock" id="Duck::Constants">
|
179
|
+
<header class="groupHeader">
|
180
|
+
<span class="groupName">Constants</span>
|
181
|
+
</header>
|
182
|
+
<div class="memberBlock" id="Duck::MAX_VELOCITY">
|
183
|
+
<div class="memberHeader">
|
184
|
+
<div class="label labelConstant">
|
185
|
+
constant
|
186
|
+
</div>
|
187
|
+
<span class="memberName">MAX_VELOCITY</span>
|
188
|
+
</div>
|
189
|
+
<pre class="memberSignature"></pre>
|
190
|
+
<div class="memberComment">
|
191
|
+
|
192
|
+
</div>
|
193
|
+
</div>
|
194
|
+
</section>
|
195
|
+
<section class="groupBlock" id="Duck::ClassMethods">
|
196
|
+
<header class="groupHeader">
|
197
|
+
<span class="groupName">Class Methods</span>
|
198
|
+
</header>
|
199
|
+
<div class="memberBlock" id="Duck::new">
|
200
|
+
<div class="memberHeader">
|
201
|
+
<div class="label labelClassMethod">
|
202
|
+
class method
|
203
|
+
</div>
|
204
|
+
<div class="label labelPublic">
|
205
|
+
public
|
206
|
+
</div>
|
207
|
+
<span class="memberName">new</span>
|
208
|
+
</div>
|
209
|
+
<pre class="memberSignature">new(domestic, rubber)</pre>
|
210
|
+
<div class="memberComment">
|
211
|
+
<p>Creates a new duck.</p>
|
212
|
+
</div>
|
213
|
+
<details class="memberCode"><summary>Source code</summary><pre><span class="ruby-comment"># File example.rb, line 114</span>
|
214
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">domestic</span>, <span class="ruby-identifier">rubber</span>)
|
215
|
+
<span class="ruby-ivar">@domestic</span> = <span class="ruby-identifier">domestic</span>
|
216
|
+
<span class="ruby-ivar">@rubber</span> = <span class="ruby-identifier">rubber</span>
|
217
|
+
<span class="ruby-identifier">@@rubber_ducks</span> <span class="ruby-operator"><<</span> <span class="ruby-keyword">self</span> <span class="ruby-keyword">if</span> <span class="ruby-identifier">rubber</span>
|
218
|
+
<span class="ruby-keyword">end</span></pre></details>
|
219
|
+
</div>
|
220
|
+
<div class="memberBlock" id="Duck::rubber_ducks">
|
221
|
+
<div class="memberHeader">
|
222
|
+
<div class="label labelClassMethod">
|
223
|
+
class method
|
224
|
+
</div>
|
225
|
+
<div class="label labelPublic">
|
226
|
+
public
|
227
|
+
</div>
|
228
|
+
<span class="memberName">rubber_ducks</span>
|
229
|
+
</div>
|
230
|
+
<pre class="memberSignature">rubber_ducks()</pre>
|
231
|
+
<div class="memberComment">
|
232
|
+
<p>Returns list of all rubber ducks.</p>
|
233
|
+
</div>
|
234
|
+
<details class="memberCode"><summary>Source code</summary><pre><span class="ruby-comment"># File example.rb, line 109</span>
|
235
|
+
<span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">rubber_ducks</span>
|
236
|
+
<span class="ruby-identifier">@@rubber_ducks</span>
|
237
|
+
<span class="ruby-keyword">end</span></pre></details>
|
238
|
+
</div>
|
239
|
+
</section>
|
240
|
+
<section class="groupBlock" id="Duck::InstanceAttributes">
|
241
|
+
<header class="groupHeader">
|
242
|
+
<span class="groupName">Instance Attributes</span>
|
243
|
+
</header>
|
244
|
+
<div class="memberBlock" id="Duck::domestic">
|
245
|
+
<div class="memberHeader">
|
246
|
+
<div class="label labelInstanceAttribute">
|
247
|
+
instance attribute
|
248
|
+
</div>
|
249
|
+
<div class="label labelPublic">
|
250
|
+
public
|
251
|
+
</div>
|
252
|
+
<span class="memberName">domestic</span>
|
253
|
+
</div>
|
254
|
+
<pre class="memberSignature"></pre>
|
255
|
+
<div class="memberComment">
|
256
|
+
<p>True for domestic ducks.</p>
|
257
|
+
</div>
|
258
|
+
</div>
|
259
|
+
<div class="memberBlock" id="Duck::rubber">
|
260
|
+
<div class="memberHeader">
|
261
|
+
<div class="label labelInstanceAttribute">
|
262
|
+
instance attribute
|
263
|
+
</div>
|
264
|
+
<div class="label labelPublic">
|
265
|
+
public
|
266
|
+
</div>
|
267
|
+
<span class="memberName">rubber</span>
|
268
|
+
</div>
|
269
|
+
<pre class="memberSignature"></pre>
|
270
|
+
<div class="memberComment">
|
271
|
+
<p>True for rubber ducks.</p>
|
272
|
+
</div>
|
273
|
+
</div>
|
274
|
+
</section>
|
275
|
+
<section class="groupBlock" id="Duck::InstanceMethods">
|
276
|
+
<header class="groupHeader">
|
277
|
+
<span class="groupName">Instance Methods</span>
|
278
|
+
</header>
|
279
|
+
<div class="memberBlock" id="Duck::quack">
|
280
|
+
<div class="memberHeader">
|
281
|
+
<div class="label labelInstanceMethod">
|
282
|
+
instance method
|
283
|
+
</div>
|
284
|
+
<div class="label labelPrivate">
|
285
|
+
private
|
286
|
+
</div>
|
287
|
+
<span class="memberName">quack</span>
|
288
|
+
</div>
|
289
|
+
<pre class="memberSignature">quack()</pre>
|
290
|
+
<div class="memberComment">
|
291
|
+
<p>Implements quacking</p>
|
292
|
+
</div>
|
293
|
+
<details class="memberCode"><summary>Source code</summary><pre><span class="ruby-comment"># File example.rb, line 86</span>
|
294
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">quack</span>
|
295
|
+
<span class="ruby-string">'quack'</span>
|
296
|
+
<span class="ruby-keyword">end</span></pre></details>
|
297
|
+
</div>
|
298
|
+
<div class="memberBlock" id="Duck::speak">
|
299
|
+
<div class="memberHeader">
|
300
|
+
<div class="label labelInstanceMethod">
|
301
|
+
instance method
|
302
|
+
</div>
|
303
|
+
<div class="label labelPublic">
|
304
|
+
public
|
305
|
+
</div>
|
306
|
+
<span class="memberName">speak</span>
|
307
|
+
</div>
|
308
|
+
<pre class="memberSignature">speak() { |speech| ... }</pre>
|
309
|
+
<div class="memberComment">
|
310
|
+
<p><a href="Duck.html">Duck</a> overrides generic implementation.</p>
|
311
|
+
</div>
|
312
|
+
<details class="memberCode"><summary>Source code</summary><pre><span class="ruby-comment"># File example.rb, line 80</span>
|
313
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">speak</span>
|
314
|
+
<span class="ruby-identifier">speech</span> = <span class="ruby-identifier">quack</span>
|
315
|
+
<span class="ruby-keyword">yield</span> <span class="ruby-identifier">speech</span>
|
316
|
+
<span class="ruby-keyword">end</span></pre></details>
|
317
|
+
</div>
|
318
|
+
<div class="memberBlock" id="Duck::useful?">
|
319
|
+
<div class="memberHeader">
|
320
|
+
<div class="label labelInstanceMethod">
|
321
|
+
instance method
|
322
|
+
</div>
|
323
|
+
<div class="label labelPublic">
|
324
|
+
public
|
325
|
+
</div>
|
326
|
+
<span class="memberName">useful?</span>
|
327
|
+
</div>
|
328
|
+
<pre class="memberSignature">Bird.useful? -> bool</pre>
|
329
|
+
<div class="memberComment">
|
330
|
+
<p>Checks if this duck is a useful one.</p>
|
331
|
+
</div>
|
332
|
+
<details class="memberCode"><summary>Source code</summary><pre><span class="ruby-comment"># File example.rb, line 124</span>
|
333
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">useful?</span>
|
334
|
+
<span class="ruby-ivar">@domestic</span> <span class="ruby-operator">||</span> <span class="ruby-ivar">@rubber</span>
|
335
|
+
<span class="ruby-keyword">end</span></pre></details>
|
336
|
+
</div>
|
337
|
+
</section>
|
338
|
+
</article>
|
339
|
+
<article class="classBlock" id="Object">
|
340
|
+
<header class="classHeader">
|
341
|
+
<div class="label labelClass">
|
342
|
+
class
|
343
|
+
</div>
|
344
|
+
<span class="className">Object</span>
|
345
|
+
</header>
|
346
|
+
<div class="classComment">
|
347
|
+
|
348
|
+
</div>
|
349
|
+
<section class="groupBlock" id="Object::Constants">
|
350
|
+
<header class="groupHeader">
|
351
|
+
<span class="groupName">Constants</span>
|
352
|
+
</header>
|
353
|
+
<div class="memberBlock" id="Object::DEFAULT_DUCK_VELOCITY">
|
354
|
+
<div class="memberHeader">
|
355
|
+
<div class="label labelConstant">
|
356
|
+
constant
|
357
|
+
</div>
|
358
|
+
<span class="memberName">DEFAULT_DUCK_VELOCITY</span>
|
359
|
+
</div>
|
360
|
+
<pre class="memberSignature"></pre>
|
361
|
+
<div class="memberComment">
|
362
|
+
<p>Default velocity for a flying duck.</p>
|
363
|
+
</div>
|
364
|
+
</div>
|
365
|
+
</section>
|
366
|
+
</article>
|
367
|
+
<article class="classBlock" id="Waterfowl">
|
368
|
+
<header class="classHeader">
|
369
|
+
<div class="label labelModule">
|
370
|
+
module
|
371
|
+
</div>
|
372
|
+
<span class="className">Waterfowl</span>
|
373
|
+
</header>
|
374
|
+
<div class="classComment">
|
375
|
+
<p>A mixin for waterfowl creatures.</p>
|
376
|
+
</div>
|
377
|
+
<section class="groupBlock" id="Waterfowl::InstanceMethods">
|
378
|
+
<header class="groupHeader">
|
379
|
+
<span class="groupName">Instance Methods</span>
|
380
|
+
</header>
|
381
|
+
<div class="memberBlock" id="Waterfowl::swim">
|
382
|
+
<div class="memberHeader">
|
383
|
+
<div class="label labelInstanceMethod">
|
384
|
+
instance method
|
385
|
+
</div>
|
386
|
+
<div class="label labelPublic">
|
387
|
+
public
|
388
|
+
</div>
|
389
|
+
<span class="memberName">swim</span>
|
390
|
+
</div>
|
391
|
+
<pre class="memberSignature">swim()</pre>
|
392
|
+
<div class="memberComment">
|
393
|
+
<p>Swimming helper.</p>
|
394
|
+
</div>
|
395
|
+
<details class="memberCode"><summary>Source code</summary><pre><span class="ruby-comment"># File example.rb, line 19</span>
|
396
|
+
<span class="ruby-keyword">def</span> <span class="ruby-identifier">swim</span>
|
397
|
+
<span class="ruby-identifier">puts</span> <span class="ruby-string">'swimming around'</span>
|
398
|
+
<span class="ruby-keyword">end</span></pre></details>
|
399
|
+
</div>
|
400
|
+
</section>
|
401
|
+
</article>
|
402
|
+
</main>
|
403
|
+
</body>
|
404
|
+
</html>
|