yard-ghpages 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,289 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Yard::GHPages::Tasks
8
+
9
+ &mdash; Documentation by YARD 0.8.5.2
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (T)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../Yard.html" title="Yard (module)">Yard</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../GHPages.html" title="Yard::GHPages (module)">GHPages</a></span></span>
36
+ &raquo;
37
+ <span class="title">Tasks</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Yard::GHPages::Tasks
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Yard::GHPages::Tasks</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r2">Includes:</dt>
94
+ <dd class="r2">Rake::DSL</dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/yard-ghpages.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
113
+
114
+ <h2>
115
+ Class Method Summary
116
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
117
+ </h2>
118
+
119
+ <ul class="summary">
120
+
121
+ <li class="public ">
122
+ <span class="summary_signature">
123
+
124
+ <a href="#install_tasks-class_method" title="install_tasks (class method)">+ (Object) <strong>install_tasks</strong>(opts = {}) </a>
125
+
126
+
127
+
128
+ </span>
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+
138
+ <span class="summary_desc"><div class='inline'></div></span>
139
+
140
+ </li>
141
+
142
+
143
+ </ul>
144
+
145
+ <h2>
146
+ Instance Method Summary
147
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
148
+ </h2>
149
+
150
+ <ul class="summary">
151
+
152
+ <li class="public ">
153
+ <span class="summary_signature">
154
+
155
+ <a href="#install-instance_method" title="#install (instance method)">- (Object) <strong>install</strong>(opts) </a>
156
+
157
+
158
+
159
+ </span>
160
+
161
+
162
+
163
+
164
+
165
+
166
+
167
+
168
+
169
+ <span class="summary_desc"><div class='inline'></div></span>
170
+
171
+ </li>
172
+
173
+
174
+ </ul>
175
+
176
+
177
+
178
+
179
+
180
+ <div id="class_method_details" class="method_details_list">
181
+ <h2>Class Method Details</h2>
182
+
183
+
184
+ <div class="method_details first">
185
+ <h3 class="signature first" id="install_tasks-class_method">
186
+
187
+ + (<tt>Object</tt>) <strong>install_tasks</strong>(opts = {})
188
+
189
+
190
+
191
+
192
+
193
+ </h3><table class="source_code">
194
+ <tr>
195
+ <td>
196
+ <pre class="lines">
197
+
198
+
199
+ 12
200
+ 13
201
+ 14</pre>
202
+ </td>
203
+ <td>
204
+ <pre class="code"><span class="info file"># File 'lib/yard-ghpages.rb', line 12</span>
205
+
206
+ <span class='kw'>def</span> <span class='id identifier rubyid_install_tasks'>install_tasks</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
207
+ <span class='id identifier rubyid_new'>new</span><span class='period'>.</span><span class='id identifier rubyid_install'>install</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
208
+ <span class='kw'>end</span></pre>
209
+ </td>
210
+ </tr>
211
+ </table>
212
+ </div>
213
+
214
+ </div>
215
+
216
+ <div id="instance_method_details" class="method_details_list">
217
+ <h2>Instance Method Details</h2>
218
+
219
+
220
+ <div class="method_details first">
221
+ <h3 class="signature first" id="install-instance_method">
222
+
223
+ - (<tt>Object</tt>) <strong>install</strong>(opts)
224
+
225
+
226
+
227
+
228
+
229
+ </h3><table class="source_code">
230
+ <tr>
231
+ <td>
232
+ <pre class="lines">
233
+
234
+
235
+ 17
236
+ 18
237
+ 19
238
+ 20
239
+ 21
240
+ 22
241
+ 23
242
+ 24
243
+ 25
244
+ 26
245
+ 27
246
+ 28
247
+ 29
248
+ 30
249
+ 31
250
+ 32
251
+ 33</pre>
252
+ </td>
253
+ <td>
254
+ <pre class="code"><span class="info file"># File 'lib/yard-ghpages.rb', line 17</span>
255
+
256
+ <span class='kw'>def</span> <span class='id identifier rubyid_install'>install</span><span class='lparen'>(</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
257
+ <span class='id identifier rubyid_namespace'>namespace</span> <span class='symbol'>:yard</span> <span class='kw'>do</span>
258
+ <span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>build yard documentation</span><span class='tstring_end'>'</span></span>
259
+ <span class='id identifier rubyid_task'>task</span> <span class='symbol'>:build</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span>
260
+ <span class='const'>YARD</span><span class='op'>::</span><span class='const'>CLI</span><span class='op'>::</span><span class='const'>Yardoc</span><span class='period'>.</span><span class='id identifier rubyid_run'>run</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_opts'>opts</span><span class='rparen'>)</span>
261
+ <span class='kw'>end</span>
262
+
263
+ <span class='id identifier rubyid_desc'>desc</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>publish documentation to gh-pages</span><span class='tstring_end'>'</span></span>
264
+ <span class='id identifier rubyid_task'>task</span> <span class='symbol'>:publish</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_t'>t</span><span class='op'>|</span>
265
+ <span class='const'>Yard</span><span class='op'>::</span><span class='const'>GHPages</span><span class='op'>::</span><span class='const'>BranchMerger</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_g'>g</span><span class='op'>|</span>
266
+ <span class='id identifier rubyid_g'>g</span><span class='period'>.</span><span class='id identifier rubyid_source'>source</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>branch:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>master</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>directory:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>doc</span><span class='tstring_end'>'</span></span> <span class='rbrace'>}</span>
267
+ <span class='id identifier rubyid_g'>g</span><span class='period'>.</span><span class='id identifier rubyid_destination'>destination</span> <span class='op'>=</span> <span class='lbrace'>{</span> <span class='label'>branch:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>gh-pages</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span>
268
+ <span class='id identifier rubyid_g'>g</span><span class='period'>.</span><span class='id identifier rubyid_message'>message</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Updated website</span><span class='tstring_end'>'</span></span> <span class='comment'># defaults to 'Updated files.'
269
+ </span> <span class='kw'>end</span><span class='period'>.</span><span class='id identifier rubyid_merge'>merge</span>
270
+ <span class='kw'>end</span>
271
+ <span class='kw'>end</span>
272
+ <span class='kw'>end</span></pre>
273
+ </td>
274
+ </tr>
275
+ </table>
276
+ </div>
277
+
278
+ </div>
279
+
280
+ </div>
281
+
282
+ <div id="footer">
283
+ Generated on Mon Jul 8 13:41:16 2013 by
284
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
285
+ 0.8.5.2 (ruby-1.9.3).
286
+ </div>
287
+
288
+ </body>
289
+ </html>
data/doc/_index.html ADDED
@@ -0,0 +1,155 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Documentation by YARD 0.8.5.2
8
+
9
+ </title>
10
+
11
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
12
+
13
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <script type="text/javascript" charset="utf-8">
16
+ hasFrames = window.top.frames.main ? true : false;
17
+ relpath = '';
18
+ framesUrl = "frames.html#!" + escape(window.location.href);
19
+ </script>
20
+
21
+
22
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <div id="header">
30
+ <div id="menu">
31
+
32
+
33
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
34
+ </div>
35
+
36
+ <div id="search">
37
+
38
+ <a class="full_list_link" id="class_list_link"
39
+ href="class_list.html">
40
+ Class List
41
+ </a>
42
+
43
+ <a class="full_list_link" id="method_list_link"
44
+ href="method_list.html">
45
+ Method List
46
+ </a>
47
+
48
+ <a class="full_list_link" id="file_list_link"
49
+ href="file_list.html">
50
+ File List
51
+ </a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1 class="noborder title">Documentation by YARD 0.8.5.2</h1>
60
+ <div id="listing">
61
+ <h1 class="alphaindex">Alphabetic Index</h1>
62
+
63
+ <h2>File Listing</h2>
64
+ <ul id="files" class="index_inline_list">
65
+
66
+
67
+ <li class="r1"><a href="index.html" title="README">README</a></li>
68
+
69
+
70
+ </ul>
71
+
72
+ <div class="clear"></div>
73
+ <h2>Namespace Listing A-Z</h2>
74
+
75
+
76
+
77
+
78
+ <table>
79
+ <tr>
80
+ <td valign='top' width="33%">
81
+
82
+
83
+ <ul id="alpha_B" class="alpha">
84
+ <li class="letter">B</li>
85
+ <ul>
86
+
87
+ <li>
88
+ <span class='object_link'><a href="Yard/GHPages/BranchMerger.html" title="Yard::GHPages::BranchMerger (class)">BranchMerger</a></span>
89
+
90
+ <small>(Yard::GHPages)</small>
91
+
92
+ </li>
93
+
94
+ </ul>
95
+ </ul>
96
+
97
+
98
+ <ul id="alpha_G" class="alpha">
99
+ <li class="letter">G</li>
100
+ <ul>
101
+
102
+ <li>
103
+ <span class='object_link'><a href="Yard/GHPages.html" title="Yard::GHPages (module)">GHPages</a></span>
104
+
105
+ <small>(Yard)</small>
106
+
107
+ </li>
108
+
109
+ </ul>
110
+ </ul>
111
+
112
+
113
+ <ul id="alpha_T" class="alpha">
114
+ <li class="letter">T</li>
115
+ <ul>
116
+
117
+ <li>
118
+ <span class='object_link'><a href="Yard/GHPages/Tasks.html" title="Yard::GHPages::Tasks (class)">Tasks</a></span>
119
+
120
+ <small>(Yard::GHPages)</small>
121
+
122
+ </li>
123
+
124
+ </ul>
125
+ </ul>
126
+
127
+
128
+ <ul id="alpha_Y" class="alpha">
129
+ <li class="letter">Y</li>
130
+ <ul>
131
+
132
+ <li>
133
+ <span class='object_link'><a href="Yard.html" title="Yard (module)">Yard</a></span>
134
+
135
+ </li>
136
+
137
+ </ul>
138
+ </ul>
139
+
140
+ </td>
141
+ </tr>
142
+ </table>
143
+
144
+ </div>
145
+
146
+ </div>
147
+
148
+ <div id="footer">
149
+ Generated on Mon Jul 8 13:41:15 2013 by
150
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
151
+ 0.8.5.2 (ruby-1.9.3).
152
+ </div>
153
+
154
+ </body>
155
+ </html>
@@ -0,0 +1,53 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html>
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+
7
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
8
+
9
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
10
+
11
+
12
+
13
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
16
+
17
+
18
+ <base id="base_target" target="_parent" />
19
+ </head>
20
+ <body>
21
+ <script type="text/javascript" charset="utf-8">
22
+ if (window.top.frames.main) {
23
+ document.getElementById('base_target').target = 'main';
24
+ document.body.className = 'frames';
25
+ }
26
+ </script>
27
+ <div id="content">
28
+ <h1 id="full_list_header">Class List</h1>
29
+ <div id="nav">
30
+
31
+ <span><a target="_self" href="class_list.html">
32
+ Classes
33
+ </a></span>
34
+
35
+ <span><a target="_self" href="method_list.html">
36
+ Methods
37
+ </a></span>
38
+
39
+ <span><a target="_self" href="file_list.html">
40
+ Files
41
+ </a></span>
42
+
43
+ </div>
44
+ <div id="search">Search: <input type="text" /></div>
45
+
46
+ <ul id="full_list" class="class">
47
+ <li><span class='object_link'><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></span></li>
48
+ <li><a class='toggle'></a> <span class='object_link'><a href="Yard.html" title="Yard (module)">Yard</a></span><small class='search_info'>Top Level Namespace</small></li><ul><li><a class='toggle'></a> <span class='object_link'><a href="Yard/GHPages.html" title="Yard::GHPages (module)">GHPages</a></span><small class='search_info'>Yard</small></li><ul><li><span class='object_link'><a href="Yard/GHPages/BranchMerger.html" title="Yard::GHPages::BranchMerger (class)">BranchMerger</a></span> &lt; Object<small class='search_info'>Yard::GHPages</small></li><li><span class='object_link'><a href="Yard/GHPages/Tasks.html" title="Yard::GHPages::Tasks (class)">Tasks</a></span> &lt; Object<small class='search_info'>Yard::GHPages</small></li></ul></ul>
49
+
50
+ </ul>
51
+ </div>
52
+ </body>
53
+ </html>