detroit-rdoc 0.2.0 → 0.4.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 +7 -0
- data/README.md +42 -0
- data/lib/detroit-rdoc.rb +53 -68
- data/lib/detroit-ri.rb +56 -61
- data/man/detroit-rdoc.5 +4 -4
- data/man/detroit-rdoc.5.html +8 -8
- data/man/detroit-rdoc.5.ronn +4 -4
- data/man/detroit-ri.5 +4 -4
- data/man/detroit-ri.5.html +8 -8
- data/man/detroit-ri.5.ronn +4 -4
- metadata +40 -24
- data/.ruby +0 -35
- data/COPYING.rdoc +0 -21
- data/README.rdoc +0 -22
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: dcf324b40dc8f2374074750a8403d6de535b404b
|
4
|
+
data.tar.gz: e5674a6c5db624bfb8a92519f337c4a7171ced8c
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: d77c916d499b7e84d65e7dd8aaa54d428b38b9821f2ebb71c2d3cbc7e9e7fb6ed4d4436ad43727f0cd873a64dbeb155c520836b346db9719cdfc51696917e987
|
7
|
+
data.tar.gz: 47ef2ea7979910e3f1fe3f531cf23cda06bf48b4843cc80c5db41246c9f99df28d8cfb459401512d33330cda9f0e740c4c6c17c4fd1ecbd0b154703c0845a863
|
data/README.md
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
# Detroit RDoc Tool
|
2
|
+
|
3
|
+
[Website](http://rubyworks.github.com/detroit-rdoc) /
|
4
|
+
[Report Issue](http://github.com/rubyworks/detroit-rdoc/issues) /
|
5
|
+
[Development](http://github.com/rubyworks/detroit-rdoc)
|
6
|
+
|
7
|
+
[](http://travis-ci.org/rubyworks/detroit-rdoc)
|
8
|
+
[](http://badge.fury.io/rb/detroit-rdoc)
|
9
|
+
[](http://flattr.com/thing/324911/Rubyworks-Ruby-Development-Fund)
|
10
|
+
|
11
|
+
|
12
|
+
## About
|
13
|
+
|
14
|
+
RDoc and RI documentation tools are used to generate RDoc and RI
|
15
|
+
documentation files for a Ruby project.
|
16
|
+
|
17
|
+
|
18
|
+
## Install
|
19
|
+
|
20
|
+
### With RubyGems
|
21
|
+
|
22
|
+
$ gem install detroit-rdoc
|
23
|
+
|
24
|
+
|
25
|
+
## Legal
|
26
|
+
|
27
|
+
Detroit RDoc
|
28
|
+
|
29
|
+
Copyright (c) 2011 Rubyworks
|
30
|
+
|
31
|
+
This program is free software: you can redistribute it and/or modify
|
32
|
+
it under the terms of the GNU General Public License as published by
|
33
|
+
the Free Software Foundation, either version 3 of the License, or
|
34
|
+
(at your option) any later version.
|
35
|
+
|
36
|
+
This program is distributed in the hope that it will be useful,
|
37
|
+
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
38
|
+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
39
|
+
GNU General Public License for more details.
|
40
|
+
|
41
|
+
See LICENSE.txt for details.
|
42
|
+
|
data/lib/detroit-rdoc.rb
CHANGED
@@ -1,12 +1,8 @@
|
|
1
|
-
require 'detroit
|
1
|
+
require 'detroit-standard'
|
2
2
|
|
3
3
|
module Detroit
|
4
4
|
|
5
|
-
|
6
|
-
def RDoc(options={})
|
7
|
-
RDoc.new(options)
|
8
|
-
end
|
9
|
-
|
5
|
+
##
|
10
6
|
# RDoc documentation tool generates RDocs for Ruby project.
|
11
7
|
#
|
12
8
|
# By default it generates the rdoc documentaiton at doc/rdoc,
|
@@ -14,8 +10,23 @@ module Detroit
|
|
14
10
|
# directory, in which case the rdoc documentation will be
|
15
11
|
# stored there.
|
16
12
|
#
|
13
|
+
# * document
|
14
|
+
# * reset
|
15
|
+
# * clean
|
16
|
+
# * purge
|
17
|
+
#
|
17
18
|
class RDoc < Tool
|
18
19
|
|
20
|
+
# Works with the standard assembly.
|
21
|
+
#
|
22
|
+
# @!parse
|
23
|
+
# include Standard
|
24
|
+
#
|
25
|
+
assembly Standard
|
26
|
+
|
27
|
+
# Location of manpage for tool.
|
28
|
+
MANPAGE = File.dirname(__FILE__) + '/../man/detroit-rdoc.5'
|
29
|
+
|
19
30
|
# Default location to store rdoc documentation files.
|
20
31
|
DEFAULT_OUTPUT = "doc"
|
21
32
|
|
@@ -31,8 +42,18 @@ module Detroit
|
|
31
42
|
# Deafult extra options to add to rdoc call.
|
32
43
|
DEFAULT_EXTRA = ''
|
33
44
|
|
34
|
-
|
35
|
-
#
|
45
|
+
# NOTE: Due to a bug in RDoc this needs to be done for now
|
46
|
+
# so that alternate templates can be used.
|
47
|
+
def prerequisite
|
48
|
+
begin
|
49
|
+
require 'rubygems'
|
50
|
+
gem('rdoc')
|
51
|
+
rescue LoadError
|
52
|
+
$stderr.puts "Oh no! No modern rdoc!"
|
53
|
+
end
|
54
|
+
#require 'rdoc'
|
55
|
+
require 'rdoc/rdoc'
|
56
|
+
end
|
36
57
|
|
37
58
|
# Title of documents. Defaults to general metadata title field.
|
38
59
|
attr_accessor :title
|
@@ -74,31 +95,6 @@ module Detroit
|
|
74
95
|
attr_accessor :extra
|
75
96
|
|
76
97
|
|
77
|
-
# A S S E M B L Y M E T H O D S
|
78
|
-
|
79
|
-
#
|
80
|
-
def assemble?(station, options={})
|
81
|
-
case station
|
82
|
-
when :document then true
|
83
|
-
when :reset then true
|
84
|
-
when :clean then true
|
85
|
-
when :purge then true
|
86
|
-
end
|
87
|
-
end
|
88
|
-
|
89
|
-
# Attach to document, reset and purge assembly stations.
|
90
|
-
def assemble(station, options={})
|
91
|
-
case station
|
92
|
-
when :document then document
|
93
|
-
when :reset then reset
|
94
|
-
when :clean then clean
|
95
|
-
when :purge then purge
|
96
|
-
end
|
97
|
-
end
|
98
|
-
|
99
|
-
|
100
|
-
# S E R V I C E M E T H O D S
|
101
|
-
|
102
98
|
# Generate Rdoc documentation. Settings are the
|
103
99
|
# same as the rdoc command's option, with two
|
104
100
|
# exceptions: +inline+ for +inline-source+ and
|
@@ -168,16 +164,6 @@ module Detroit
|
|
168
164
|
end
|
169
165
|
end
|
170
166
|
|
171
|
-
# Are RDocs current and not in need of updating?
|
172
|
-
# If yes, returns string message, otherwise `false`.
|
173
|
-
def current?
|
174
|
-
if outofdate?(output, *resolved_files)
|
175
|
-
return false
|
176
|
-
else
|
177
|
-
"RDocs are current (#{output})"
|
178
|
-
end
|
179
|
-
end
|
180
|
-
|
181
167
|
# Reset output directory, marking it as out-of-date.
|
182
168
|
def reset
|
183
169
|
if directory?(output)
|
@@ -198,6 +184,28 @@ module Detroit
|
|
198
184
|
end
|
199
185
|
end
|
200
186
|
|
187
|
+
# Are RDocs current and not in need of updating?
|
188
|
+
# If yes, returns string message, otherwise `false`.
|
189
|
+
def current?
|
190
|
+
if outofdate?(output, *resolved_files)
|
191
|
+
return false
|
192
|
+
else
|
193
|
+
"RDocs are current (#{output})"
|
194
|
+
end
|
195
|
+
end
|
196
|
+
|
197
|
+
# This tool ties into the `document`, `reset`, `clean` and `purge` stations
|
198
|
+
# of the standard assembly.
|
199
|
+
#
|
200
|
+
# @return [Boolean,Symbol]
|
201
|
+
def assemble?(station, options={})
|
202
|
+
return true if station == :document
|
203
|
+
return true if station == :reset
|
204
|
+
return true if station == :clean
|
205
|
+
return true if station == :purge
|
206
|
+
return false
|
207
|
+
end
|
208
|
+
|
201
209
|
private
|
202
210
|
|
203
211
|
#
|
@@ -215,6 +223,8 @@ module Detroit
|
|
215
223
|
|
216
224
|
# Setup default attribute values.
|
217
225
|
def initialize_defaults
|
226
|
+
super
|
227
|
+
|
218
228
|
@title = metadata.title
|
219
229
|
@files = metadata.loadpath + ['[A-Z]*', 'bin'] # DEFAULT_FILES
|
220
230
|
@output = Dir[DEFAULT_OUTPUT_MATCH].first || DEFAULT_OUTPUT
|
@@ -290,31 +300,6 @@ module Detroit
|
|
290
300
|
end
|
291
301
|
end
|
292
302
|
|
293
|
-
#
|
294
|
-
def require_rdoc
|
295
|
-
# NOTE: Due to a bug in RDoc this needs to be done for now
|
296
|
-
# so that alternate templates can be used.
|
297
|
-
begin
|
298
|
-
require 'rubygems'
|
299
|
-
gem('rdoc')
|
300
|
-
rescue LoadError
|
301
|
-
$stderr.puts "Oh no! No modern rdoc!"
|
302
|
-
end
|
303
|
-
#require 'rdoc'
|
304
|
-
require 'rdoc/rdoc'
|
305
|
-
end
|
306
|
-
|
307
|
-
#
|
308
|
-
def initialize_requires
|
309
|
-
require_rdoc
|
310
|
-
end
|
311
|
-
|
312
|
-
public
|
313
|
-
|
314
|
-
def self.man_page
|
315
|
-
File.dirname(__FILE__)+'/../man/detroit-rdoc.5'
|
316
|
-
end
|
317
|
-
|
318
303
|
end
|
319
304
|
|
320
305
|
end
|
data/lib/detroit-ri.rb
CHANGED
@@ -1,8 +1,8 @@
|
|
1
|
-
require 'detroit
|
1
|
+
require 'detroit-standard'
|
2
2
|
|
3
3
|
module Detroit
|
4
4
|
|
5
|
-
# Create new RI tool with specified
|
5
|
+
# Create new RI tool with specified `options`.
|
6
6
|
def RI(options={})
|
7
7
|
RI.new(options)
|
8
8
|
end
|
@@ -15,22 +15,35 @@ module Detroit
|
|
15
15
|
# directory, in which case the ri documentation will be
|
16
16
|
# stored there.
|
17
17
|
#
|
18
|
+
# * document
|
19
|
+
# * reset
|
20
|
+
# * clean
|
21
|
+
# * purge
|
22
|
+
#
|
18
23
|
class RI < Tool
|
19
24
|
|
20
|
-
#
|
21
|
-
|
22
|
-
|
23
|
-
#
|
24
|
-
|
25
|
+
# Works with the Standard assembly.
|
26
|
+
#
|
27
|
+
# @!parse
|
28
|
+
# include Standard
|
29
|
+
#
|
30
|
+
assembly Standard
|
25
31
|
|
26
|
-
#
|
27
|
-
|
32
|
+
# Location of manpage for tool.
|
33
|
+
MANPAGE = File.dirname(__FILE__) + '/../man/detroit-ri.5'
|
28
34
|
|
29
35
|
#
|
30
|
-
def
|
31
|
-
|
32
|
-
|
33
|
-
|
36
|
+
def prerequisite
|
37
|
+
# NOTE: Due to a bug in RDoc this needs to be done for now
|
38
|
+
# so that alternate templates can be used.
|
39
|
+
begin
|
40
|
+
require 'rubygems'
|
41
|
+
gem('rdoc')
|
42
|
+
rescue LoadError
|
43
|
+
$stderr.puts "Oh no! No modern rdoc!"
|
44
|
+
end
|
45
|
+
#require 'rdoc'
|
46
|
+
require 'rdoc/rdoc'
|
34
47
|
end
|
35
48
|
|
36
49
|
# Where to save rdoc files (doc/rdoc).
|
@@ -48,29 +61,6 @@ module Detroit
|
|
48
61
|
# Additional options passed to the rdoc command.
|
49
62
|
attr_accessor :extra
|
50
63
|
|
51
|
-
|
52
|
-
# A S S E M B L Y M E T H O D S
|
53
|
-
|
54
|
-
#
|
55
|
-
def assemble?(station, options={})
|
56
|
-
case station
|
57
|
-
when :document then true
|
58
|
-
when :reset then true
|
59
|
-
when :clean then true
|
60
|
-
when :purge then true
|
61
|
-
end
|
62
|
-
end
|
63
|
-
|
64
|
-
# Attach to document, reset and purge assembly stations.
|
65
|
-
def assemble(station, options={})
|
66
|
-
case station
|
67
|
-
when :document then document
|
68
|
-
when :reset then reset
|
69
|
-
when :clean then clean
|
70
|
-
when :purge then purge
|
71
|
-
end
|
72
|
-
end
|
73
|
-
|
74
64
|
# Generate ri documentation. This utilizes
|
75
65
|
# rdoc to produce the appropriate files.
|
76
66
|
#
|
@@ -125,8 +115,38 @@ module Detroit
|
|
125
115
|
end
|
126
116
|
end
|
127
117
|
|
118
|
+
# This tool ties into the `document`, `reset`, `clean` and `purge` stations
|
119
|
+
# of the standard assembly.
|
120
|
+
#
|
121
|
+
# @return [Boolean,Symbol]
|
122
|
+
def assemble?(station, options={})
|
123
|
+
return true if station == :document
|
124
|
+
return true if station == :reset
|
125
|
+
return true if station == :clean
|
126
|
+
return true if station == :purge
|
127
|
+
return false
|
128
|
+
end
|
129
|
+
|
128
130
|
private
|
129
131
|
|
132
|
+
# Default location to store ri documentation files.
|
133
|
+
DEFAULT_OUTPUT = ".rdoc"
|
134
|
+
|
135
|
+
# Locations to check for existence in deciding where to store ri documentation.
|
136
|
+
DEFAULT_OUTPUT_MATCH = "{.rdoc,.ri,ri,doc/ri}"
|
137
|
+
|
138
|
+
# Default extra options to add to rdoc call.
|
139
|
+
DEFAULT_EXTRA = ''
|
140
|
+
|
141
|
+
#
|
142
|
+
def initialize_defaults
|
143
|
+
super
|
144
|
+
|
145
|
+
@files = metadata.loadpath
|
146
|
+
@output = Dir[DEFAULT_OUTPUT_MATCH].first || DEFAULT_OUTPUT
|
147
|
+
@extra = DEFAULT_EXTRA
|
148
|
+
end
|
149
|
+
|
130
150
|
# Generate ri docs for input targets.
|
131
151
|
#
|
132
152
|
# TODO: Use RDoc programmatically rather than via shell.
|
@@ -145,31 +165,6 @@ module Detroit
|
|
145
165
|
end
|
146
166
|
end
|
147
167
|
|
148
|
-
#
|
149
|
-
def require_rdoc
|
150
|
-
# NOTE: Due to a bug in RDoc this needs to be done for now
|
151
|
-
# so that alternate templates can be used.
|
152
|
-
begin
|
153
|
-
require 'rubygems'
|
154
|
-
gem('rdoc')
|
155
|
-
rescue LoadError
|
156
|
-
$stderr.puts "Oh no! No modern rdoc!"
|
157
|
-
end
|
158
|
-
#require 'rdoc'
|
159
|
-
require 'rdoc/rdoc'
|
160
|
-
end
|
161
|
-
|
162
|
-
#
|
163
|
-
def initialize_requires
|
164
|
-
require_rdoc
|
165
|
-
end
|
166
|
-
|
167
|
-
public
|
168
|
-
|
169
|
-
def self.man_page
|
170
|
-
File.dirname(__FILE__)+'/../man/detroit-ri.5'
|
171
|
-
end
|
172
|
-
|
173
168
|
end
|
174
169
|
|
175
170
|
end
|
data/man/detroit-rdoc.5
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "DETROIT\-RDOC" "5" "
|
4
|
+
.TH "DETROIT\-RDOC" "5" "January 2014" "" ""
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBdetroit\-rdoc\fR \- generate rdoc api documentation via detroit
|
@@ -13,7 +13,7 @@ The RDoc plug\-in for Detroit utilizes the rdoc documentation tool to generate A
|
|
13
13
|
This plug\-in package also includes detroit\-ri(5)\.
|
14
14
|
.
|
15
15
|
.SH "OPTIONS"
|
16
|
-
The following options can be used in the Detroit
|
16
|
+
The following options can be used in the Detroit toolchain file to define an RDoc tool instance\.
|
17
17
|
.
|
18
18
|
.IP "\(bu" 4
|
19
19
|
\fBtitle\fR \- Title of documents\. Defaults to general metadata title field\.
|
@@ -98,10 +98,10 @@ Development Site \fIhttp://github\.com/detroit/detroit\-rdoc\fR
|
|
98
98
|
.IP "" 0
|
99
99
|
.
|
100
100
|
.SH "COPYRIGHT"
|
101
|
-
Copyright (c) 2010
|
101
|
+
Copyright (c) 2010 Rubyworks
|
102
102
|
.
|
103
103
|
.P
|
104
|
-
Detroit RDoc is distributable in accordance with the
|
104
|
+
Detroit RDoc is distributable in accordance with the GPL v3 license\.
|
105
105
|
.
|
106
106
|
.SH "SEE ALSO"
|
107
107
|
detroit(1), rdoc(1), detroit\-ri(5)
|
data/man/detroit-rdoc.5.html
CHANGED
@@ -60,7 +60,7 @@
|
|
60
60
|
<a href="#RESOURCES">RESOURCES</a>
|
61
61
|
<a href="#COPYRIGHT">COPYRIGHT</a>
|
62
62
|
<a href="#SEE-ALSO">SEE ALSO</a>
|
63
|
-
|
63
|
+
</div>
|
64
64
|
|
65
65
|
<ol class='man-decor man-head man head'>
|
66
66
|
<li class='tl'>detroit-rdoc(5)</li>
|
@@ -79,12 +79,12 @@
|
|
79
79
|
tool to generate API documentation for a project. It can also
|
80
80
|
be used to generate ri documentation file.</p>
|
81
81
|
|
82
|
-
<p>This plug-in package also includes <a href="detroit-ri.5.html"
|
82
|
+
<p>This plug-in package also includes <a class="man-ref" href="detroit-ri.5.html">detroit-ri<span class="s">(5)</span></a>.</p>
|
83
83
|
|
84
84
|
<h2 id="OPTIONS">OPTIONS</h2>
|
85
85
|
|
86
|
-
<p>The following options can be used in the Detroit
|
87
|
-
to define an RDoc
|
86
|
+
<p>The following options can be used in the Detroit toolchain file
|
87
|
+
to define an RDoc tool instance.</p>
|
88
88
|
|
89
89
|
<ul>
|
90
90
|
<li><p><code>title</code> - Title of documents. Defaults to general metadata title field.</p></li>
|
@@ -141,18 +141,18 @@ details.</p>
|
|
141
141
|
|
142
142
|
<h2 id="COPYRIGHT">COPYRIGHT</h2>
|
143
143
|
|
144
|
-
<p>Copyright (c) 2010
|
144
|
+
<p>Copyright (c) 2010 Rubyworks</p>
|
145
145
|
|
146
|
-
<p>Detroit RDoc is distributable in accordance with the
|
146
|
+
<p>Detroit RDoc is distributable in accordance with the GPL v3 license.</p>
|
147
147
|
|
148
148
|
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
149
149
|
|
150
|
-
<p><span class="man-ref">detroit<span class="s">(1)</span></span>, <span class="man-ref">rdoc<span class="s">(1)</span></span>, <a href="detroit-ri.5.html"
|
150
|
+
<p><span class="man-ref">detroit<span class="s">(1)</span></span>, <span class="man-ref">rdoc<span class="s">(1)</span></span>, <a class="man-ref" href="detroit-ri.5.html">detroit-ri<span class="s">(5)</span></a></p>
|
151
151
|
|
152
152
|
|
153
153
|
<ol class='man-decor man-foot man foot'>
|
154
154
|
<li class='tl'></li>
|
155
|
-
<li class='tc'>
|
155
|
+
<li class='tc'>January 2014</li>
|
156
156
|
<li class='tr'>detroit-rdoc(5)</li>
|
157
157
|
</ol>
|
158
158
|
|
data/man/detroit-rdoc.5.ronn
CHANGED
@@ -12,8 +12,8 @@ This plug-in package also includes detroit-ri(5).
|
|
12
12
|
|
13
13
|
## OPTIONS
|
14
14
|
|
15
|
-
The following options can be used in the Detroit
|
16
|
-
to define an RDoc
|
15
|
+
The following options can be used in the Detroit toolchain file
|
16
|
+
to define an RDoc tool instance.
|
17
17
|
|
18
18
|
* `title` - Title of documents. Defaults to general metadata title field.
|
19
19
|
|
@@ -75,9 +75,9 @@ For more information:
|
|
75
75
|
|
76
76
|
## COPYRIGHT
|
77
77
|
|
78
|
-
Copyright (c) 2010
|
78
|
+
Copyright (c) 2010 Rubyworks
|
79
79
|
|
80
|
-
Detroit RDoc is distributable in accordance with the
|
80
|
+
Detroit RDoc is distributable in accordance with the GPL v3 license.
|
81
81
|
|
82
82
|
|
83
83
|
## SEE ALSO
|
data/man/detroit-ri.5
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
.\" generated with Ronn/v0.7.3
|
2
2
|
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
3
3
|
.
|
4
|
-
.TH "DETROIT\-RI" "5" "
|
4
|
+
.TH "DETROIT\-RI" "5" "January 2014" "" ""
|
5
5
|
.
|
6
6
|
.SH "NAME"
|
7
7
|
\fBdetroit\-ri\fR \- generate ri documentation files via detroit
|
@@ -13,7 +13,7 @@ The RI plug\-in for Detroit utilizes the rdoc documentation tool to generate ri
|
|
13
13
|
This plug\-in is included with the \fBdetroit\-rdoc\fR package, which also includes the detroit\-rdoc(5) plug\-in\.
|
14
14
|
.
|
15
15
|
.SH "OPTIONS"
|
16
|
-
The following options can be used in the Detroit
|
16
|
+
The following options can be used in the Detroit toolchain file to define an RDoc tool instance\.
|
17
17
|
.
|
18
18
|
.IP "\(bu" 4
|
19
19
|
\fBoutput\fR \- Where to save rdoc files\. The default is \fB\.rdoc/\fR\.
|
@@ -79,10 +79,10 @@ Development Site \fIhttp://github\.com/detroit/detroit\-rdoc\fR
|
|
79
79
|
.IP "" 0
|
80
80
|
.
|
81
81
|
.SH "COPYRIGHT"
|
82
|
-
Copyright (c) 2010
|
82
|
+
Copyright (c) 2010 Rubyworks
|
83
83
|
.
|
84
84
|
.P
|
85
|
-
Detroit RDoc is distributable in accordance with the
|
85
|
+
Detroit RDoc is distributable in accordance with the GPL v3 license\.
|
86
86
|
.
|
87
87
|
.SH "SEE ALSO"
|
88
88
|
detroit(1), rdoc(1), detroit\-rdoc(5)
|
data/man/detroit-ri.5.html
CHANGED
@@ -60,7 +60,7 @@
|
|
60
60
|
<a href="#RESOURCES">RESOURCES</a>
|
61
61
|
<a href="#COPYRIGHT">COPYRIGHT</a>
|
62
62
|
<a href="#SEE-ALSO">SEE ALSO</a>
|
63
|
-
|
63
|
+
</div>
|
64
64
|
|
65
65
|
<ol class='man-decor man-head man head'>
|
66
66
|
<li class='tl'>detroit-ri(5)</li>
|
@@ -79,12 +79,12 @@
|
|
79
79
|
tool to generate ri reference documentation for a project.</p>
|
80
80
|
|
81
81
|
<p>This plug-in is included with the <code>detroit-rdoc</code> package,
|
82
|
-
which also includes the <a href="detroit-rdoc.5.html"
|
82
|
+
which also includes the <a class="man-ref" href="detroit-rdoc.5.html">detroit-rdoc<span class="s">(5)</span></a> plug-in.</p>
|
83
83
|
|
84
84
|
<h2 id="OPTIONS">OPTIONS</h2>
|
85
85
|
|
86
|
-
<p>The following options can be used in the Detroit
|
87
|
-
to define an RDoc
|
86
|
+
<p>The following options can be used in the Detroit toolchain file
|
87
|
+
to define an RDoc tool instance.</p>
|
88
88
|
|
89
89
|
<ul>
|
90
90
|
<li><p><code>output</code> - Where to save rdoc files. The default is <code>.rdoc/</code>.</p></li>
|
@@ -128,18 +128,18 @@ details.</p>
|
|
128
128
|
|
129
129
|
<h2 id="COPYRIGHT">COPYRIGHT</h2>
|
130
130
|
|
131
|
-
<p>Copyright (c) 2010
|
131
|
+
<p>Copyright (c) 2010 Rubyworks</p>
|
132
132
|
|
133
|
-
<p>Detroit RDoc is distributable in accordance with the
|
133
|
+
<p>Detroit RDoc is distributable in accordance with the GPL v3 license.</p>
|
134
134
|
|
135
135
|
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
136
136
|
|
137
|
-
<p><span class="man-ref">detroit<span class="s">(1)</span></span>, <span class="man-ref">rdoc<span class="s">(1)</span></span>, <a href="detroit-rdoc.5.html"
|
137
|
+
<p><span class="man-ref">detroit<span class="s">(1)</span></span>, <span class="man-ref">rdoc<span class="s">(1)</span></span>, <a class="man-ref" href="detroit-rdoc.5.html">detroit-rdoc<span class="s">(5)</span></a></p>
|
138
138
|
|
139
139
|
|
140
140
|
<ol class='man-decor man-foot man foot'>
|
141
141
|
<li class='tl'></li>
|
142
|
-
<li class='tc'>
|
142
|
+
<li class='tc'>January 2014</li>
|
143
143
|
<li class='tr'>detroit-ri(5)</li>
|
144
144
|
</ol>
|
145
145
|
|
data/man/detroit-ri.5.ronn
CHANGED
@@ -12,8 +12,8 @@ which also includes the detroit-rdoc(5) plug-in.
|
|
12
12
|
|
13
13
|
## OPTIONS
|
14
14
|
|
15
|
-
The following options can be used in the Detroit
|
16
|
-
to define an RDoc
|
15
|
+
The following options can be used in the Detroit toolchain file
|
16
|
+
to define an RDoc tool instance.
|
17
17
|
|
18
18
|
* `output` - Where to save rdoc files. The default is `.rdoc/`.
|
19
19
|
|
@@ -57,9 +57,9 @@ details.
|
|
57
57
|
|
58
58
|
## COPYRIGHT
|
59
59
|
|
60
|
-
Copyright (c) 2010
|
60
|
+
Copyright (c) 2010 Rubyworks
|
61
61
|
|
62
|
-
Detroit RDoc is distributable in accordance with the
|
62
|
+
Detroit RDoc is distributable in accordance with the GPL v3 license.
|
63
63
|
|
64
64
|
|
65
65
|
## SEE ALSO
|
metadata
CHANGED
@@ -1,38 +1,57 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: detroit-rdoc
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
5
|
-
prerelease:
|
4
|
+
version: 0.4.0
|
6
5
|
platform: ruby
|
7
6
|
authors:
|
8
7
|
- T. Sawyer
|
9
8
|
autorequire:
|
10
9
|
bindir: bin
|
11
10
|
cert_chain: []
|
12
|
-
date:
|
11
|
+
date: 2014-01-15 00:00:00.000000000 Z
|
13
12
|
dependencies:
|
14
13
|
- !ruby/object:Gem::Dependency
|
15
14
|
name: detroit
|
16
|
-
requirement:
|
17
|
-
none: false
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
18
16
|
requirements:
|
19
|
-
- -
|
17
|
+
- - '>='
|
20
18
|
- !ruby/object:Gem::Version
|
21
|
-
version: 0.
|
19
|
+
version: 0.4.0
|
22
20
|
type: :runtime
|
23
21
|
prerelease: false
|
24
|
-
version_requirements:
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '>='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.4.0
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: detroit-standard
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
25
41
|
- !ruby/object:Gem::Dependency
|
26
42
|
name: rdoc
|
27
|
-
requirement:
|
28
|
-
none: false
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
29
44
|
requirements:
|
30
|
-
- -
|
45
|
+
- - '>='
|
31
46
|
- !ruby/object:Gem::Version
|
32
47
|
version: '0'
|
33
48
|
type: :runtime
|
34
49
|
prerelease: false
|
35
|
-
version_requirements:
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
36
55
|
description: RDoc and RI plugins for Detroit build system.
|
37
56
|
email:
|
38
57
|
- transfire@gmail.com
|
@@ -40,10 +59,8 @@ executables: []
|
|
40
59
|
extensions: []
|
41
60
|
extra_rdoc_files:
|
42
61
|
- LICENSE.txt
|
43
|
-
- README.
|
44
|
-
- COPYING.rdoc
|
62
|
+
- README.md
|
45
63
|
files:
|
46
|
-
- .ruby
|
47
64
|
- lib/detroit-rdoc.rb
|
48
65
|
- lib/detroit-ri.rb
|
49
66
|
- man/detroit-rdoc.5
|
@@ -52,32 +69,31 @@ files:
|
|
52
69
|
- man/detroit-ri.5
|
53
70
|
- man/detroit-ri.5.html
|
54
71
|
- man/detroit-ri.5.ronn
|
72
|
+
- README.md
|
55
73
|
- LICENSE.txt
|
56
|
-
- README.rdoc
|
57
|
-
- COPYING.rdoc
|
58
74
|
homepage: http://detroit.github.com/
|
59
75
|
licenses:
|
60
|
-
- GPL-3
|
76
|
+
- GPL-3.0
|
77
|
+
metadata: {}
|
61
78
|
post_install_message:
|
62
79
|
rdoc_options: []
|
63
80
|
require_paths:
|
64
81
|
- lib
|
65
82
|
required_ruby_version: !ruby/object:Gem::Requirement
|
66
|
-
none: false
|
67
83
|
requirements:
|
68
|
-
- -
|
84
|
+
- - '>='
|
69
85
|
- !ruby/object:Gem::Version
|
70
86
|
version: '0'
|
71
87
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
72
|
-
none: false
|
73
88
|
requirements:
|
74
|
-
- -
|
89
|
+
- - '>='
|
75
90
|
- !ruby/object:Gem::Version
|
76
91
|
version: '0'
|
77
92
|
requirements: []
|
78
93
|
rubyforge_project:
|
79
|
-
rubygems_version:
|
94
|
+
rubygems_version: 2.0.3
|
80
95
|
signing_key:
|
81
|
-
specification_version:
|
96
|
+
specification_version: 4
|
82
97
|
summary: RDoc and RI plugins for Detroit
|
83
98
|
test_files: []
|
99
|
+
has_rdoc:
|
data/.ruby
DELETED
@@ -1,35 +0,0 @@
|
|
1
|
-
---
|
2
|
-
source:
|
3
|
-
- meta
|
4
|
-
authors:
|
5
|
-
- name: T. Sawyer
|
6
|
-
email: transfire@gmail.com
|
7
|
-
copyrights:
|
8
|
-
- holder: Thomas Sawyer
|
9
|
-
year: '2011'
|
10
|
-
license: GPL-3
|
11
|
-
requirements:
|
12
|
-
- name: detroit
|
13
|
-
version: 0.3.0+
|
14
|
-
- name: rdoc
|
15
|
-
dependencies: []
|
16
|
-
alternatives: []
|
17
|
-
conflicts: []
|
18
|
-
repositories: []
|
19
|
-
resources:
|
20
|
-
home: http://detroit.github.com/
|
21
|
-
code: http://github.com/detroit/detroit-rdoc
|
22
|
-
mail: http://google.groups.com/group/rubyworks-mailinglist
|
23
|
-
extra: {}
|
24
|
-
load_path:
|
25
|
-
- lib
|
26
|
-
revision: 0
|
27
|
-
created: '2011-10-16'
|
28
|
-
summary: RDoc and RI plugins for Detroit
|
29
|
-
title: Detroit RDoc
|
30
|
-
version: 0.2.0
|
31
|
-
name: detroit-rdoc
|
32
|
-
suite: detroit
|
33
|
-
description: RDoc and RI plugins for Detroit build system.
|
34
|
-
organization: rubyworks
|
35
|
-
date: '2012-04-01'
|
data/COPYING.rdoc
DELETED
@@ -1,21 +0,0 @@
|
|
1
|
-
= COPYRIGHT NOTICES
|
2
|
-
|
3
|
-
== Detroit RDoc
|
4
|
-
|
5
|
-
Copyright (c) 2011 Thomas Sawyer
|
6
|
-
|
7
|
-
This program is free software: you can redistribute it and/or modify
|
8
|
-
it under the terms of the GNU General Public License as published by
|
9
|
-
the Free Software Foundation, either version 3 of the License, or
|
10
|
-
(at your option) any later version.
|
11
|
-
|
12
|
-
This program is distributed in the hope that it will be useful,
|
13
|
-
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
14
|
-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
15
|
-
GNU General Public License for more details.
|
16
|
-
|
17
|
-
You should have received a copy of the GNU General Public License
|
18
|
-
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
19
|
-
|
20
|
-
(http://detroit.github.com)
|
21
|
-
|
data/README.rdoc
DELETED
@@ -1,22 +0,0 @@
|
|
1
|
-
= Detroit RDoc Tool
|
2
|
-
|
3
|
-
|
4
|
-
== DESCRIPTION
|
5
|
-
|
6
|
-
RDoc and RI documentation tools are used to generate RDoc and RI
|
7
|
-
documentation files for a Ruby project.
|
8
|
-
|
9
|
-
|
10
|
-
== INSTALL
|
11
|
-
|
12
|
-
$ gem install detroit-rdoc
|
13
|
-
|
14
|
-
|
15
|
-
== COPYRIGHT
|
16
|
-
|
17
|
-
Copyright (c) 2011 Thomas Sawyer
|
18
|
-
|
19
|
-
GPL v.3 license
|
20
|
-
|
21
|
-
See COPYING.rdoc and GPL3.txt file for details.
|
22
|
-
|