detroit-rdoc 0.1.0 → 0.2.0
Sign up to get free protection for your applications and to get access to all the features.
- data/.ruby +16 -10
- data/{GPL3.txt → LICENSE.txt} +0 -0
- data/lib/detroit-rdoc.rb +17 -12
- data/lib/detroit-ri.rb +24 -1
- data/man/detroit-rdoc.5 +107 -0
- data/man/detroit-rdoc.5.html +161 -0
- data/man/detroit-rdoc.5.ronn +85 -0
- data/man/detroit-ri.5 +88 -0
- data/man/detroit-ri.5.html +148 -0
- data/man/detroit-ri.5.ronn +67 -0
- metadata +36 -7
data/.ruby
CHANGED
|
@@ -1,4 +1,6 @@
|
|
|
1
1
|
---
|
|
2
|
+
source:
|
|
3
|
+
- meta
|
|
2
4
|
authors:
|
|
3
5
|
- name: T. Sawyer
|
|
4
6
|
email: transfire@gmail.com
|
|
@@ -6,24 +8,28 @@ copyrights:
|
|
|
6
8
|
- holder: Thomas Sawyer
|
|
7
9
|
year: '2011'
|
|
8
10
|
license: GPL-3
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
11
|
+
requirements:
|
|
12
|
+
- name: detroit
|
|
13
|
+
version: 0.3.0+
|
|
14
|
+
- name: rdoc
|
|
12
15
|
dependencies: []
|
|
16
|
+
alternatives: []
|
|
17
|
+
conflicts: []
|
|
13
18
|
repositories: []
|
|
14
19
|
resources:
|
|
15
20
|
home: http://detroit.github.com/
|
|
16
21
|
code: http://github.com/detroit/detroit-rdoc
|
|
17
22
|
mail: http://google.groups.com/group/rubyworks-mailinglist
|
|
23
|
+
extra: {}
|
|
18
24
|
load_path:
|
|
19
25
|
- lib
|
|
20
|
-
extra: {}
|
|
21
26
|
revision: 0
|
|
22
|
-
|
|
23
|
-
source: []
|
|
24
|
-
alternatives: []
|
|
25
|
-
title: Detroit RDoc
|
|
26
|
-
version: 0.1.0
|
|
27
|
+
created: '2011-10-16'
|
|
27
28
|
summary: RDoc and RI plugins for Detroit
|
|
29
|
+
title: Detroit RDoc
|
|
30
|
+
version: 0.2.0
|
|
31
|
+
name: detroit-rdoc
|
|
32
|
+
suite: detroit
|
|
28
33
|
description: RDoc and RI plugins for Detroit build system.
|
|
29
|
-
|
|
34
|
+
organization: rubyworks
|
|
35
|
+
date: '2012-04-01'
|
data/{GPL3.txt → LICENSE.txt}
RENAMED
|
File without changes
|
data/lib/detroit-rdoc.rb
CHANGED
|
@@ -74,21 +74,26 @@ module Detroit
|
|
|
74
74
|
attr_accessor :extra
|
|
75
75
|
|
|
76
76
|
|
|
77
|
-
# A S S E M B L Y
|
|
77
|
+
# A S S E M B L Y M E T H O D S
|
|
78
78
|
|
|
79
|
-
#
|
|
80
|
-
def
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
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
87
|
end
|
|
88
88
|
|
|
89
|
-
# Attach
|
|
90
|
-
def
|
|
91
|
-
|
|
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
|
|
92
97
|
end
|
|
93
98
|
|
|
94
99
|
|
data/lib/detroit-ri.rb
CHANGED
|
@@ -48,6 +48,29 @@ module Detroit
|
|
|
48
48
|
# Additional options passed to the rdoc command.
|
|
49
49
|
attr_accessor :extra
|
|
50
50
|
|
|
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
|
+
|
|
51
74
|
# Generate ri documentation. This utilizes
|
|
52
75
|
# rdoc to produce the appropriate files.
|
|
53
76
|
#
|
|
@@ -102,7 +125,7 @@ module Detroit
|
|
|
102
125
|
end
|
|
103
126
|
end
|
|
104
127
|
|
|
105
|
-
|
|
128
|
+
private
|
|
106
129
|
|
|
107
130
|
# Generate ri docs for input targets.
|
|
108
131
|
#
|
data/man/detroit-rdoc.5
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
3
|
+
.
|
|
4
|
+
.TH "DETROIT\-RDOC" "5" "October 2011" "" ""
|
|
5
|
+
.
|
|
6
|
+
.SH "NAME"
|
|
7
|
+
\fBdetroit\-rdoc\fR \- generate rdoc api documentation via detroit
|
|
8
|
+
.
|
|
9
|
+
.SH "DESCRIPTION"
|
|
10
|
+
The RDoc plug\-in for Detroit utilizes the rdoc documentation tool to generate API documentation for a project\. It can also be used to generate ri documentation file\.
|
|
11
|
+
.
|
|
12
|
+
.P
|
|
13
|
+
This plug\-in package also includes detroit\-ri(5)\.
|
|
14
|
+
.
|
|
15
|
+
.SH "OPTIONS"
|
|
16
|
+
The following options can be used in the Detroit assembly file to define an RDoc service\.
|
|
17
|
+
.
|
|
18
|
+
.IP "\(bu" 4
|
|
19
|
+
\fBtitle\fR \- Title of documents\. Defaults to general metadata title field\.
|
|
20
|
+
.
|
|
21
|
+
.IP "\(bu" 4
|
|
22
|
+
\fBoutput\fR \- Where to save rdoc files\. The default is \fBdoc/\fR\.
|
|
23
|
+
.
|
|
24
|
+
.IP "\(bu" 4
|
|
25
|
+
\fBformat\fR \- Documentation format\. This defaults to \fBENV[\'RDOC_FORMAT\']\fR or \'darkfish\'\.
|
|
26
|
+
.
|
|
27
|
+
.IP "\(bu" 4
|
|
28
|
+
\fBtemplate\fR \- Template to use\. Some formats support multiple templates\. This defaults to \fBENV[\'RDOC_TEMPLATE\']\fR\.
|
|
29
|
+
.
|
|
30
|
+
.IP "\(bu" 4
|
|
31
|
+
\fBmain\fR \- Main file\. This can be a file pattern\. This default is matched to \fBREADME{,\.*}\fR\.
|
|
32
|
+
.
|
|
33
|
+
.IP "\(bu" 4
|
|
34
|
+
\fBfiles\fR/\fBinclude\fR \- Which files to document\. The default is \fBlib/\fR\.
|
|
35
|
+
.
|
|
36
|
+
.IP "\(bu" 4
|
|
37
|
+
\fBexclude\fR \- Paths to specifically exclude\.
|
|
38
|
+
.
|
|
39
|
+
.IP "\(bu" 4
|
|
40
|
+
\fBignore\fR \- File patterns to ignore\.
|
|
41
|
+
.
|
|
42
|
+
.IP "\(bu" 4
|
|
43
|
+
\fBadfile\fR \- Ad file html snippet to add to html rdocs\.
|
|
44
|
+
.
|
|
45
|
+
.IP "\(bu" 4
|
|
46
|
+
\fBextra\fR \- Additional options passed to the \fBrdoc\fR command\.
|
|
47
|
+
.
|
|
48
|
+
.IP "" 0
|
|
49
|
+
.
|
|
50
|
+
.SH "EXAMPLES"
|
|
51
|
+
Option defaults are fairly typical\. So the simplest entry is something like:
|
|
52
|
+
.
|
|
53
|
+
.IP "" 4
|
|
54
|
+
.
|
|
55
|
+
.nf
|
|
56
|
+
|
|
57
|
+
rdoc:
|
|
58
|
+
output: doc/
|
|
59
|
+
.
|
|
60
|
+
.fi
|
|
61
|
+
.
|
|
62
|
+
.IP "" 0
|
|
63
|
+
.
|
|
64
|
+
.P
|
|
65
|
+
A more complex example might look like:
|
|
66
|
+
.
|
|
67
|
+
.IP "" 4
|
|
68
|
+
.
|
|
69
|
+
.nf
|
|
70
|
+
|
|
71
|
+
rdoc:
|
|
72
|
+
title: MyApp API
|
|
73
|
+
include:
|
|
74
|
+
\- lib
|
|
75
|
+
\- [A\-Z]*\.*
|
|
76
|
+
ignore:
|
|
77
|
+
\- \'*\.yml\'
|
|
78
|
+
output: site/api
|
|
79
|
+
main: INTRO\.rdoc
|
|
80
|
+
format: hanna
|
|
81
|
+
.
|
|
82
|
+
.fi
|
|
83
|
+
.
|
|
84
|
+
.IP "" 0
|
|
85
|
+
.
|
|
86
|
+
.P
|
|
87
|
+
The above examples use the YAML\-base assembly format\. Assembly files can also be Ruby\-based\. See Detroit documentation for more details\.
|
|
88
|
+
.
|
|
89
|
+
.SH "RESOURCES"
|
|
90
|
+
For more information:
|
|
91
|
+
.
|
|
92
|
+
.IP "\(bu" 4
|
|
93
|
+
API Documentation \fIhttp://rubydoc\.info/gems/detroit\-rdoc\fR
|
|
94
|
+
.
|
|
95
|
+
.IP "\(bu" 4
|
|
96
|
+
Development Site \fIhttp://github\.com/detroit/detroit\-rdoc\fR
|
|
97
|
+
.
|
|
98
|
+
.IP "" 0
|
|
99
|
+
.
|
|
100
|
+
.SH "COPYRIGHT"
|
|
101
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
102
|
+
.
|
|
103
|
+
.P
|
|
104
|
+
Detroit RDoc is distributable in accordance with the GPLv3 license\.
|
|
105
|
+
.
|
|
106
|
+
.SH "SEE ALSO"
|
|
107
|
+
detroit(1), rdoc(1), detroit\-ri(5)
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
|
5
|
+
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
|
6
|
+
<title>detroit-rdoc(5) - generate rdoc api documentation via detroit</title>
|
|
7
|
+
<style type='text/css' media='all'>
|
|
8
|
+
/* style: man */
|
|
9
|
+
body#manpage {margin:0}
|
|
10
|
+
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
|
11
|
+
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
|
12
|
+
.mp h2 {margin:10px 0 0 0}
|
|
13
|
+
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
|
14
|
+
.mp h3 {margin:0 0 0 4ex}
|
|
15
|
+
.mp dt {margin:0;clear:left}
|
|
16
|
+
.mp dt.flush {float:left;width:8ex}
|
|
17
|
+
.mp dd {margin:0 0 0 9ex}
|
|
18
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
|
19
|
+
.mp pre {margin-bottom:20px}
|
|
20
|
+
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
|
21
|
+
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
|
22
|
+
.mp img {display:block;margin:auto}
|
|
23
|
+
.mp h1.man-title {display:none}
|
|
24
|
+
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
|
25
|
+
.mp h2 {font-size:16px;line-height:1.25}
|
|
26
|
+
.mp h1 {font-size:20px;line-height:2}
|
|
27
|
+
.mp {text-align:justify;background:#fff}
|
|
28
|
+
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
|
29
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
|
30
|
+
.mp u {text-decoration:underline}
|
|
31
|
+
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
|
32
|
+
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
|
33
|
+
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
|
34
|
+
.mp b.man-ref {font-weight:normal;color:#434241}
|
|
35
|
+
.mp pre {padding:0 4ex}
|
|
36
|
+
.mp pre code {font-weight:normal;color:#434241}
|
|
37
|
+
.mp h2+pre,h3+pre {padding-left:0}
|
|
38
|
+
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
|
39
|
+
ol.man-decor {width:100%}
|
|
40
|
+
ol.man-decor li.tl {text-align:left}
|
|
41
|
+
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
|
42
|
+
ol.man-decor li.tr {text-align:right;float:right}
|
|
43
|
+
</style>
|
|
44
|
+
</head>
|
|
45
|
+
<!--
|
|
46
|
+
The following styles are deprecated and will be removed at some point:
|
|
47
|
+
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
|
48
|
+
|
|
49
|
+
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
|
50
|
+
.man-navigation should be used instead.
|
|
51
|
+
-->
|
|
52
|
+
<body id='manpage'>
|
|
53
|
+
<div class='mp' id='man'>
|
|
54
|
+
|
|
55
|
+
<div class='man-navigation' style='display:none'>
|
|
56
|
+
<a href="#NAME">NAME</a>
|
|
57
|
+
<a href="#DESCRIPTION">DESCRIPTION</a>
|
|
58
|
+
<a href="#OPTIONS">OPTIONS</a>
|
|
59
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
|
60
|
+
<a href="#RESOURCES">RESOURCES</a>
|
|
61
|
+
<a href="#COPYRIGHT">COPYRIGHT</a>
|
|
62
|
+
<a href="#SEE-ALSO">SEE ALSO</a>
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
<ol class='man-decor man-head man head'>
|
|
66
|
+
<li class='tl'>detroit-rdoc(5)</li>
|
|
67
|
+
<li class='tc'></li>
|
|
68
|
+
<li class='tr'>detroit-rdoc(5)</li>
|
|
69
|
+
</ol>
|
|
70
|
+
|
|
71
|
+
<h2 id="NAME">NAME</h2>
|
|
72
|
+
<p class="man-name">
|
|
73
|
+
<code>detroit-rdoc</code> - <span class="man-whatis">generate rdoc api documentation via detroit</span>
|
|
74
|
+
</p>
|
|
75
|
+
|
|
76
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
77
|
+
|
|
78
|
+
<p>The RDoc plug-in for Detroit utilizes the rdoc documentation
|
|
79
|
+
tool to generate API documentation for a project. It can also
|
|
80
|
+
be used to generate ri documentation file.</p>
|
|
81
|
+
|
|
82
|
+
<p>This plug-in package also includes <a href="detroit-ri.5.html" class="man-ref">detroit-ri<span class="s">(5)</span></a>.</p>
|
|
83
|
+
|
|
84
|
+
<h2 id="OPTIONS">OPTIONS</h2>
|
|
85
|
+
|
|
86
|
+
<p>The following options can be used in the Detroit assembly file
|
|
87
|
+
to define an RDoc service.</p>
|
|
88
|
+
|
|
89
|
+
<ul>
|
|
90
|
+
<li><p><code>title</code> - Title of documents. Defaults to general metadata title field.</p></li>
|
|
91
|
+
<li><p><code>output</code> - Where to save rdoc files. The default is <code>doc/</code>.</p></li>
|
|
92
|
+
<li><p><code>format</code> - Documentation format. This defaults to <code>ENV['RDOC_FORMAT']</code>
|
|
93
|
+
or 'darkfish'.</p></li>
|
|
94
|
+
<li><p><code>template</code> - Template to use. Some formats support multiple templates.
|
|
95
|
+
This defaults to <code>ENV['RDOC_TEMPLATE']</code>.</p></li>
|
|
96
|
+
<li><p><code>main</code> - Main file. This can be a file pattern. This default is matched
|
|
97
|
+
to <code>README{,.*}</code>.</p></li>
|
|
98
|
+
<li><p><code>files</code>/<code>include</code> - Which files to document. The default is <code>lib/</code>.</p></li>
|
|
99
|
+
<li><p><code>exclude</code> - Paths to specifically exclude.</p></li>
|
|
100
|
+
<li><p><code>ignore</code> - File patterns to ignore.</p></li>
|
|
101
|
+
<li><p><code>adfile</code> - Ad file html snippet to add to html rdocs.</p></li>
|
|
102
|
+
<li><p><code>extra</code> - Additional options passed to the <code>rdoc</code> command.</p></li>
|
|
103
|
+
</ul>
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
107
|
+
|
|
108
|
+
<p>Option defaults are fairly typical. So the simplest entry is something like:</p>
|
|
109
|
+
|
|
110
|
+
<pre><code>rdoc:
|
|
111
|
+
output: doc/
|
|
112
|
+
</code></pre>
|
|
113
|
+
|
|
114
|
+
<p>A more complex example might look like:</p>
|
|
115
|
+
|
|
116
|
+
<pre><code>rdoc:
|
|
117
|
+
title: MyApp API
|
|
118
|
+
include:
|
|
119
|
+
- lib
|
|
120
|
+
- [A-Z]*.*
|
|
121
|
+
ignore:
|
|
122
|
+
- '*.yml'
|
|
123
|
+
output: site/api
|
|
124
|
+
main: INTRO.rdoc
|
|
125
|
+
format: hanna
|
|
126
|
+
</code></pre>
|
|
127
|
+
|
|
128
|
+
<p>The above examples use the YAML-base assembly format. Assembly
|
|
129
|
+
files can also be Ruby-based. See Detroit documentation for more
|
|
130
|
+
details.</p>
|
|
131
|
+
|
|
132
|
+
<h2 id="RESOURCES">RESOURCES</h2>
|
|
133
|
+
|
|
134
|
+
<p>For more information:</p>
|
|
135
|
+
|
|
136
|
+
<ul>
|
|
137
|
+
<li><p><a href="http://rubydoc.info/gems/detroit-rdoc">API Documentation</a></p></li>
|
|
138
|
+
<li><p><a href="http://github.com/detroit/detroit-rdoc">Development Site</a></p></li>
|
|
139
|
+
</ul>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<h2 id="COPYRIGHT">COPYRIGHT</h2>
|
|
143
|
+
|
|
144
|
+
<p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
|
|
145
|
+
|
|
146
|
+
<p>Detroit RDoc is distributable in accordance with the GPLv3 license.</p>
|
|
147
|
+
|
|
148
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
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" class="man-ref">detroit-ri<span class="s">(5)</span></a></p>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<ol class='man-decor man-foot man foot'>
|
|
154
|
+
<li class='tl'></li>
|
|
155
|
+
<li class='tc'>October 2011</li>
|
|
156
|
+
<li class='tr'>detroit-rdoc(5)</li>
|
|
157
|
+
</ol>
|
|
158
|
+
|
|
159
|
+
</div>
|
|
160
|
+
</body>
|
|
161
|
+
</html>
|
|
@@ -0,0 +1,85 @@
|
|
|
1
|
+
detroit-rdoc(5) - generate rdoc api documentation via detroit
|
|
2
|
+
=============================================================
|
|
3
|
+
|
|
4
|
+
## DESCRIPTION
|
|
5
|
+
|
|
6
|
+
The RDoc plug-in for Detroit utilizes the rdoc documentation
|
|
7
|
+
tool to generate API documentation for a project. It can also
|
|
8
|
+
be used to generate ri documentation file.
|
|
9
|
+
|
|
10
|
+
This plug-in package also includes detroit-ri(5).
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## OPTIONS
|
|
14
|
+
|
|
15
|
+
The following options can be used in the Detroit assembly file
|
|
16
|
+
to define an RDoc service.
|
|
17
|
+
|
|
18
|
+
* `title` - Title of documents. Defaults to general metadata title field.
|
|
19
|
+
|
|
20
|
+
* `output` - Where to save rdoc files. The default is `doc/`.
|
|
21
|
+
|
|
22
|
+
* `format` - Documentation format. This defaults to `ENV['RDOC_FORMAT']`
|
|
23
|
+
or 'darkfish'.
|
|
24
|
+
|
|
25
|
+
* `template` - Template to use. Some formats support multiple templates.
|
|
26
|
+
This defaults to `ENV['RDOC_TEMPLATE']`.
|
|
27
|
+
|
|
28
|
+
* `main` - Main file. This can be a file pattern. This default is matched
|
|
29
|
+
to `README{,.*}`.
|
|
30
|
+
|
|
31
|
+
* `files`/`include` - Which files to document. The default is `lib/`.
|
|
32
|
+
|
|
33
|
+
* `exclude` - Paths to specifically exclude.
|
|
34
|
+
|
|
35
|
+
* `ignore` - File patterns to ignore.
|
|
36
|
+
|
|
37
|
+
* `adfile` - Ad file html snippet to add to html rdocs.
|
|
38
|
+
|
|
39
|
+
* `extra` - Additional options passed to the `rdoc` command.
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
## EXAMPLES
|
|
43
|
+
|
|
44
|
+
Option defaults are fairly typical. So the simplest entry is something like:
|
|
45
|
+
|
|
46
|
+
rdoc:
|
|
47
|
+
output: doc/
|
|
48
|
+
|
|
49
|
+
A more complex example might look like:
|
|
50
|
+
|
|
51
|
+
rdoc:
|
|
52
|
+
title: MyApp API
|
|
53
|
+
include:
|
|
54
|
+
- lib
|
|
55
|
+
- [A-Z]*.*
|
|
56
|
+
ignore:
|
|
57
|
+
- '*.yml'
|
|
58
|
+
output: site/api
|
|
59
|
+
main: INTRO.rdoc
|
|
60
|
+
format: hanna
|
|
61
|
+
|
|
62
|
+
The above examples use the YAML-base assembly format. Assembly
|
|
63
|
+
files can also be Ruby-based. See Detroit documentation for more
|
|
64
|
+
details.
|
|
65
|
+
|
|
66
|
+
|
|
67
|
+
## RESOURCES
|
|
68
|
+
|
|
69
|
+
For more information:
|
|
70
|
+
|
|
71
|
+
* [API Documentation](http://rubydoc.info/gems/detroit-rdoc)
|
|
72
|
+
|
|
73
|
+
* [Development Site](http://github.com/detroit/detroit-rdoc)
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
## COPYRIGHT
|
|
77
|
+
|
|
78
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
79
|
+
|
|
80
|
+
Detroit RDoc is distributable in accordance with the GPLv3 license.
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
## SEE ALSO
|
|
84
|
+
|
|
85
|
+
detroit(1), rdoc(1), detroit-ri(5)
|
data/man/detroit-ri.5
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
3
|
+
.
|
|
4
|
+
.TH "DETROIT\-RI" "5" "October 2011" "" ""
|
|
5
|
+
.
|
|
6
|
+
.SH "NAME"
|
|
7
|
+
\fBdetroit\-ri\fR \- generate ri documentation files via detroit
|
|
8
|
+
.
|
|
9
|
+
.SH "DESCRIPTION"
|
|
10
|
+
The RI plug\-in for Detroit utilizes the rdoc documentation tool to generate ri reference documentation for a project\.
|
|
11
|
+
.
|
|
12
|
+
.P
|
|
13
|
+
This plug\-in is included with the \fBdetroit\-rdoc\fR package, which also includes the detroit\-rdoc(5) plug\-in\.
|
|
14
|
+
.
|
|
15
|
+
.SH "OPTIONS"
|
|
16
|
+
The following options can be used in the Detroit assembly file to define an RDoc service\.
|
|
17
|
+
.
|
|
18
|
+
.IP "\(bu" 4
|
|
19
|
+
\fBoutput\fR \- Where to save rdoc files\. The default is \fB\.rdoc/\fR\.
|
|
20
|
+
.
|
|
21
|
+
.IP "\(bu" 4
|
|
22
|
+
\fBfiles\fR/\fBinclude\fR \- Which files to document\. Defaults to \fBlib/\fR\.
|
|
23
|
+
.
|
|
24
|
+
.IP "\(bu" 4
|
|
25
|
+
\fBexclude\fR \- Paths to specifically exclude\.
|
|
26
|
+
.
|
|
27
|
+
.IP "\(bu" 4
|
|
28
|
+
\fBignore\fR \- File patterns to ignore\.
|
|
29
|
+
.
|
|
30
|
+
.IP "\(bu" 4
|
|
31
|
+
\fBextra\fR \- Additional options passed to the \fBrdoc\fR command\.
|
|
32
|
+
.
|
|
33
|
+
.IP "" 0
|
|
34
|
+
.
|
|
35
|
+
.SH "EXAMPLES"
|
|
36
|
+
Option defaults are very typical\. So the simplest entry is simply:
|
|
37
|
+
.
|
|
38
|
+
.IP "" 4
|
|
39
|
+
.
|
|
40
|
+
.nf
|
|
41
|
+
|
|
42
|
+
ri:
|
|
43
|
+
active: true
|
|
44
|
+
.
|
|
45
|
+
.fi
|
|
46
|
+
.
|
|
47
|
+
.IP "" 0
|
|
48
|
+
.
|
|
49
|
+
.P
|
|
50
|
+
A more complex example might look like:
|
|
51
|
+
.
|
|
52
|
+
.IP "" 4
|
|
53
|
+
.
|
|
54
|
+
.nf
|
|
55
|
+
|
|
56
|
+
rdoc:
|
|
57
|
+
title: MyApp API
|
|
58
|
+
include: [lib, bin]
|
|
59
|
+
ignore: [\'*\.yml\']
|
|
60
|
+
output: site/api
|
|
61
|
+
main: INTRO\.rdoc
|
|
62
|
+
format: hanna
|
|
63
|
+
.
|
|
64
|
+
.fi
|
|
65
|
+
.
|
|
66
|
+
.IP "" 0
|
|
67
|
+
.
|
|
68
|
+
.P
|
|
69
|
+
The above examples use the YAML\-base assembly format\. Assembly files can also be Ruby\-based\. See Detroit documentation for more details\.
|
|
70
|
+
.
|
|
71
|
+
.SH "RESOURCES"
|
|
72
|
+
.
|
|
73
|
+
.IP "\(bu" 4
|
|
74
|
+
API Documentation \fIhttp://rubydoc\.info/gems/detroit\-rdoc\fR
|
|
75
|
+
.
|
|
76
|
+
.IP "\(bu" 4
|
|
77
|
+
Development Site \fIhttp://github\.com/detroit/detroit\-rdoc\fR
|
|
78
|
+
.
|
|
79
|
+
.IP "" 0
|
|
80
|
+
.
|
|
81
|
+
.SH "COPYRIGHT"
|
|
82
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
83
|
+
.
|
|
84
|
+
.P
|
|
85
|
+
Detroit RDoc is distributable in accordance with the GPLv3 license\.
|
|
86
|
+
.
|
|
87
|
+
.SH "SEE ALSO"
|
|
88
|
+
detroit(1), rdoc(1), detroit\-rdoc(5)
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta http-equiv='content-type' value='text/html;charset=utf8'>
|
|
5
|
+
<meta name='generator' value='Ronn/v0.7.3 (http://github.com/rtomayko/ronn/tree/0.7.3)'>
|
|
6
|
+
<title>detroit-ri(5) - generate ri documentation files via detroit</title>
|
|
7
|
+
<style type='text/css' media='all'>
|
|
8
|
+
/* style: man */
|
|
9
|
+
body#manpage {margin:0}
|
|
10
|
+
.mp {max-width:100ex;padding:0 9ex 1ex 4ex}
|
|
11
|
+
.mp p,.mp pre,.mp ul,.mp ol,.mp dl {margin:0 0 20px 0}
|
|
12
|
+
.mp h2 {margin:10px 0 0 0}
|
|
13
|
+
.mp > p,.mp > pre,.mp > ul,.mp > ol,.mp > dl {margin-left:8ex}
|
|
14
|
+
.mp h3 {margin:0 0 0 4ex}
|
|
15
|
+
.mp dt {margin:0;clear:left}
|
|
16
|
+
.mp dt.flush {float:left;width:8ex}
|
|
17
|
+
.mp dd {margin:0 0 0 9ex}
|
|
18
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {clear:left}
|
|
19
|
+
.mp pre {margin-bottom:20px}
|
|
20
|
+
.mp pre+h2,.mp pre+h3 {margin-top:22px}
|
|
21
|
+
.mp h2+pre,.mp h3+pre {margin-top:5px}
|
|
22
|
+
.mp img {display:block;margin:auto}
|
|
23
|
+
.mp h1.man-title {display:none}
|
|
24
|
+
.mp,.mp code,.mp pre,.mp tt,.mp kbd,.mp samp,.mp h3,.mp h4 {font-family:monospace;font-size:14px;line-height:1.42857142857143}
|
|
25
|
+
.mp h2 {font-size:16px;line-height:1.25}
|
|
26
|
+
.mp h1 {font-size:20px;line-height:2}
|
|
27
|
+
.mp {text-align:justify;background:#fff}
|
|
28
|
+
.mp,.mp code,.mp pre,.mp pre code,.mp tt,.mp kbd,.mp samp {color:#131211}
|
|
29
|
+
.mp h1,.mp h2,.mp h3,.mp h4 {color:#030201}
|
|
30
|
+
.mp u {text-decoration:underline}
|
|
31
|
+
.mp code,.mp strong,.mp b {font-weight:bold;color:#131211}
|
|
32
|
+
.mp em,.mp var {font-style:italic;color:#232221;text-decoration:none}
|
|
33
|
+
.mp a,.mp a:link,.mp a:hover,.mp a code,.mp a pre,.mp a tt,.mp a kbd,.mp a samp {color:#0000ff}
|
|
34
|
+
.mp b.man-ref {font-weight:normal;color:#434241}
|
|
35
|
+
.mp pre {padding:0 4ex}
|
|
36
|
+
.mp pre code {font-weight:normal;color:#434241}
|
|
37
|
+
.mp h2+pre,h3+pre {padding-left:0}
|
|
38
|
+
ol.man-decor,ol.man-decor li {margin:3px 0 10px 0;padding:0;float:left;width:33%;list-style-type:none;text-transform:uppercase;color:#999;letter-spacing:1px}
|
|
39
|
+
ol.man-decor {width:100%}
|
|
40
|
+
ol.man-decor li.tl {text-align:left}
|
|
41
|
+
ol.man-decor li.tc {text-align:center;letter-spacing:4px}
|
|
42
|
+
ol.man-decor li.tr {text-align:right;float:right}
|
|
43
|
+
</style>
|
|
44
|
+
</head>
|
|
45
|
+
<!--
|
|
46
|
+
The following styles are deprecated and will be removed at some point:
|
|
47
|
+
div#man, div#man ol.man, div#man ol.head, div#man ol.man.
|
|
48
|
+
|
|
49
|
+
The .man-page, .man-decor, .man-head, .man-foot, .man-title, and
|
|
50
|
+
.man-navigation should be used instead.
|
|
51
|
+
-->
|
|
52
|
+
<body id='manpage'>
|
|
53
|
+
<div class='mp' id='man'>
|
|
54
|
+
|
|
55
|
+
<div class='man-navigation' style='display:none'>
|
|
56
|
+
<a href="#NAME">NAME</a>
|
|
57
|
+
<a href="#DESCRIPTION">DESCRIPTION</a>
|
|
58
|
+
<a href="#OPTIONS">OPTIONS</a>
|
|
59
|
+
<a href="#EXAMPLES">EXAMPLES</a>
|
|
60
|
+
<a href="#RESOURCES">RESOURCES</a>
|
|
61
|
+
<a href="#COPYRIGHT">COPYRIGHT</a>
|
|
62
|
+
<a href="#SEE-ALSO">SEE ALSO</a>
|
|
63
|
+
</div>
|
|
64
|
+
|
|
65
|
+
<ol class='man-decor man-head man head'>
|
|
66
|
+
<li class='tl'>detroit-ri(5)</li>
|
|
67
|
+
<li class='tc'></li>
|
|
68
|
+
<li class='tr'>detroit-ri(5)</li>
|
|
69
|
+
</ol>
|
|
70
|
+
|
|
71
|
+
<h2 id="NAME">NAME</h2>
|
|
72
|
+
<p class="man-name">
|
|
73
|
+
<code>detroit-ri</code> - <span class="man-whatis">generate ri documentation files via detroit</span>
|
|
74
|
+
</p>
|
|
75
|
+
|
|
76
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
77
|
+
|
|
78
|
+
<p>The RI plug-in for Detroit utilizes the rdoc documentation
|
|
79
|
+
tool to generate ri reference documentation for a project.</p>
|
|
80
|
+
|
|
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" class="man-ref">detroit-rdoc<span class="s">(5)</span></a> plug-in.</p>
|
|
83
|
+
|
|
84
|
+
<h2 id="OPTIONS">OPTIONS</h2>
|
|
85
|
+
|
|
86
|
+
<p>The following options can be used in the Detroit assembly file
|
|
87
|
+
to define an RDoc service.</p>
|
|
88
|
+
|
|
89
|
+
<ul>
|
|
90
|
+
<li><p><code>output</code> - Where to save rdoc files. The default is <code>.rdoc/</code>.</p></li>
|
|
91
|
+
<li><p><code>files</code>/<code>include</code> - Which files to document. Defaults to <code>lib/</code>.</p></li>
|
|
92
|
+
<li><p><code>exclude</code> - Paths to specifically exclude.</p></li>
|
|
93
|
+
<li><p><code>ignore</code> - File patterns to ignore.</p></li>
|
|
94
|
+
<li><p><code>extra</code> - Additional options passed to the <code>rdoc</code> command.</p></li>
|
|
95
|
+
</ul>
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
99
|
+
|
|
100
|
+
<p>Option defaults are very typical. So the simplest entry is simply:</p>
|
|
101
|
+
|
|
102
|
+
<pre><code>ri:
|
|
103
|
+
active: true
|
|
104
|
+
</code></pre>
|
|
105
|
+
|
|
106
|
+
<p>A more complex example might look like:</p>
|
|
107
|
+
|
|
108
|
+
<pre><code>rdoc:
|
|
109
|
+
title: MyApp API
|
|
110
|
+
include: [lib, bin]
|
|
111
|
+
ignore: ['*.yml']
|
|
112
|
+
output: site/api
|
|
113
|
+
main: INTRO.rdoc
|
|
114
|
+
format: hanna
|
|
115
|
+
</code></pre>
|
|
116
|
+
|
|
117
|
+
<p>The above examples use the YAML-base assembly format. Assembly
|
|
118
|
+
files can also be Ruby-based. See Detroit documentation for more
|
|
119
|
+
details.</p>
|
|
120
|
+
|
|
121
|
+
<h2 id="RESOURCES">RESOURCES</h2>
|
|
122
|
+
|
|
123
|
+
<ul>
|
|
124
|
+
<li><p><a href="http://rubydoc.info/gems/detroit-rdoc">API Documentation</a></p></li>
|
|
125
|
+
<li><p><a href="http://github.com/detroit/detroit-rdoc">Development Site</a></p></li>
|
|
126
|
+
</ul>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
<h2 id="COPYRIGHT">COPYRIGHT</h2>
|
|
130
|
+
|
|
131
|
+
<p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
|
|
132
|
+
|
|
133
|
+
<p>Detroit RDoc is distributable in accordance with the GPLv3 license.</p>
|
|
134
|
+
|
|
135
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
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" class="man-ref">detroit-rdoc<span class="s">(5)</span></a></p>
|
|
138
|
+
|
|
139
|
+
|
|
140
|
+
<ol class='man-decor man-foot man foot'>
|
|
141
|
+
<li class='tl'></li>
|
|
142
|
+
<li class='tc'>October 2011</li>
|
|
143
|
+
<li class='tr'>detroit-ri(5)</li>
|
|
144
|
+
</ol>
|
|
145
|
+
|
|
146
|
+
</div>
|
|
147
|
+
</body>
|
|
148
|
+
</html>
|
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
detroit-ri(5) - generate ri documentation files via detroit
|
|
2
|
+
===========================================================
|
|
3
|
+
|
|
4
|
+
## DESCRIPTION
|
|
5
|
+
|
|
6
|
+
The RI plug-in for Detroit utilizes the rdoc documentation
|
|
7
|
+
tool to generate ri reference documentation for a project.
|
|
8
|
+
|
|
9
|
+
This plug-in is included with the `detroit-rdoc` package,
|
|
10
|
+
which also includes the detroit-rdoc(5) plug-in.
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
## OPTIONS
|
|
14
|
+
|
|
15
|
+
The following options can be used in the Detroit assembly file
|
|
16
|
+
to define an RDoc service.
|
|
17
|
+
|
|
18
|
+
* `output` - Where to save rdoc files. The default is `.rdoc/`.
|
|
19
|
+
|
|
20
|
+
* `files`/`include` - Which files to document. Defaults to `lib/`.
|
|
21
|
+
|
|
22
|
+
* `exclude` - Paths to specifically exclude.
|
|
23
|
+
|
|
24
|
+
* `ignore` - File patterns to ignore.
|
|
25
|
+
|
|
26
|
+
* `extra` - Additional options passed to the `rdoc` command.
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
## EXAMPLES
|
|
30
|
+
|
|
31
|
+
Option defaults are very typical. So the simplest entry is simply:
|
|
32
|
+
|
|
33
|
+
ri:
|
|
34
|
+
active: true
|
|
35
|
+
|
|
36
|
+
A more complex example might look like:
|
|
37
|
+
|
|
38
|
+
rdoc:
|
|
39
|
+
title: MyApp API
|
|
40
|
+
include: [lib, bin]
|
|
41
|
+
ignore: ['*.yml']
|
|
42
|
+
output: site/api
|
|
43
|
+
main: INTRO.rdoc
|
|
44
|
+
format: hanna
|
|
45
|
+
|
|
46
|
+
The above examples use the YAML-base assembly format. Assembly
|
|
47
|
+
files can also be Ruby-based. See Detroit documentation for more
|
|
48
|
+
details.
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
## RESOURCES
|
|
52
|
+
|
|
53
|
+
* [API Documentation](http://rubydoc.info/gems/detroit-rdoc)
|
|
54
|
+
|
|
55
|
+
* [Development Site](http://github.com/detroit/detroit-rdoc)
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
## COPYRIGHT
|
|
59
|
+
|
|
60
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
61
|
+
|
|
62
|
+
Detroit RDoc is distributable in accordance with the GPLv3 license.
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
## SEE ALSO
|
|
66
|
+
|
|
67
|
+
detroit(1), rdoc(1), detroit-rdoc(5)
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: detroit-rdoc
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.2.0
|
|
5
5
|
prerelease:
|
|
6
6
|
platform: ruby
|
|
7
7
|
authors:
|
|
@@ -9,26 +9,55 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
13
|
-
dependencies:
|
|
12
|
+
date: 2012-04-02 00:00:00.000000000 Z
|
|
13
|
+
dependencies:
|
|
14
|
+
- !ruby/object:Gem::Dependency
|
|
15
|
+
name: detroit
|
|
16
|
+
requirement: &20993020 !ruby/object:Gem::Requirement
|
|
17
|
+
none: false
|
|
18
|
+
requirements:
|
|
19
|
+
- - ! '>='
|
|
20
|
+
- !ruby/object:Gem::Version
|
|
21
|
+
version: 0.3.0
|
|
22
|
+
type: :runtime
|
|
23
|
+
prerelease: false
|
|
24
|
+
version_requirements: *20993020
|
|
25
|
+
- !ruby/object:Gem::Dependency
|
|
26
|
+
name: rdoc
|
|
27
|
+
requirement: &20992540 !ruby/object:Gem::Requirement
|
|
28
|
+
none: false
|
|
29
|
+
requirements:
|
|
30
|
+
- - ! '>='
|
|
31
|
+
- !ruby/object:Gem::Version
|
|
32
|
+
version: '0'
|
|
33
|
+
type: :runtime
|
|
34
|
+
prerelease: false
|
|
35
|
+
version_requirements: *20992540
|
|
14
36
|
description: RDoc and RI plugins for Detroit build system.
|
|
15
37
|
email:
|
|
16
38
|
- transfire@gmail.com
|
|
17
39
|
executables: []
|
|
18
40
|
extensions: []
|
|
19
41
|
extra_rdoc_files:
|
|
20
|
-
-
|
|
42
|
+
- LICENSE.txt
|
|
21
43
|
- README.rdoc
|
|
22
44
|
- COPYING.rdoc
|
|
23
45
|
files:
|
|
24
46
|
- .ruby
|
|
25
47
|
- lib/detroit-rdoc.rb
|
|
26
48
|
- lib/detroit-ri.rb
|
|
49
|
+
- man/detroit-rdoc.5
|
|
50
|
+
- man/detroit-rdoc.5.html
|
|
51
|
+
- man/detroit-rdoc.5.ronn
|
|
52
|
+
- man/detroit-ri.5
|
|
53
|
+
- man/detroit-ri.5.html
|
|
54
|
+
- man/detroit-ri.5.ronn
|
|
55
|
+
- LICENSE.txt
|
|
27
56
|
- README.rdoc
|
|
28
|
-
- GPL3.txt
|
|
29
57
|
- COPYING.rdoc
|
|
30
58
|
homepage: http://detroit.github.com/
|
|
31
|
-
licenses:
|
|
59
|
+
licenses:
|
|
60
|
+
- GPL-3
|
|
32
61
|
post_install_message:
|
|
33
62
|
rdoc_options: []
|
|
34
63
|
require_paths:
|
|
@@ -47,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
47
76
|
version: '0'
|
|
48
77
|
requirements: []
|
|
49
78
|
rubyforge_project:
|
|
50
|
-
rubygems_version: 1.8.
|
|
79
|
+
rubygems_version: 1.8.11
|
|
51
80
|
signing_key:
|
|
52
81
|
specification_version: 3
|
|
53
82
|
summary: RDoc and RI plugins for Detroit
|