detroit-qed 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 +14 -9
- data/{GPL3.txt → LICENSE.txt} +0 -0
- data/lib/detroit-qed.rb +12 -3
- data/lib/detroit-qedoc.rb +15 -13
- data/man/detroit-qed.5 +94 -0
- data/man/detroit-qed.5.html +150 -0
- data/man/detroit-qed.5.ronn +72 -0
- data/man/detroit-qedoc.5 +74 -0
- data/man/detroit-qedoc.5.html +140 -0
- data/man/detroit-qedoc.5.ronn +60 -0
- metadata +26 -8
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,27 +8,30 @@ copyrights:
|
|
|
6
8
|
- holder: Thomas Sawyer, Rubyworks
|
|
7
9
|
year: '2011'
|
|
8
10
|
license: GPL3
|
|
9
|
-
replacements: []
|
|
10
|
-
conflicts: []
|
|
11
11
|
requirements:
|
|
12
12
|
- name: detroit
|
|
13
|
+
version: 0.3.0+
|
|
14
|
+
- name: qed
|
|
13
15
|
dependencies: []
|
|
16
|
+
alternatives: []
|
|
17
|
+
conflicts: []
|
|
14
18
|
repositories: []
|
|
15
19
|
resources:
|
|
16
20
|
home: http://detroit.github.com/
|
|
17
21
|
code: http://github.com/detroit/detroit-qed
|
|
18
22
|
mail: http://groups.google.com/group/rubyworks-mailinglist
|
|
23
|
+
extra: {}
|
|
19
24
|
load_path:
|
|
20
25
|
- lib
|
|
21
|
-
extra: {}
|
|
22
|
-
name: detroit-qed
|
|
23
|
-
source: []
|
|
24
26
|
revision: 0
|
|
25
|
-
|
|
26
|
-
title: Detroit QED
|
|
27
|
-
version: 0.1.0
|
|
27
|
+
created: '2011-10-16'
|
|
28
28
|
summary: QED plugin for Detroit
|
|
29
|
+
title: Detroit QED
|
|
30
|
+
version: 0.2.0
|
|
31
|
+
name: detroit-qed
|
|
32
|
+
suite: detroit
|
|
29
33
|
description: QED plugin for Detroit build system. This plugin will run QED specs
|
|
30
34
|
during the test phase and can create a unified spec document during documentation
|
|
31
35
|
phase.
|
|
32
|
-
|
|
36
|
+
organization: rubyworks
|
|
37
|
+
date: '2012-04-01'
|
data/{GPL3.txt → LICENSE.txt}
RENAMED
|
File without changes
|
data/lib/detroit-qed.rb
CHANGED
|
@@ -44,11 +44,20 @@ module Detroit
|
|
|
44
44
|
@requires = [paths].flatten
|
|
45
45
|
end
|
|
46
46
|
|
|
47
|
-
|
|
47
|
+
|
|
48
|
+
# A S S E M B L Y M E T H O D S
|
|
49
|
+
|
|
50
|
+
def assemble?(station, options={})
|
|
51
|
+
case station
|
|
52
|
+
when :test then true
|
|
53
|
+
end
|
|
54
|
+
end
|
|
48
55
|
|
|
49
56
|
# Attach test method to test assembly station.
|
|
50
|
-
def
|
|
51
|
-
|
|
57
|
+
def assemble(station, options={})
|
|
58
|
+
case station
|
|
59
|
+
when :test then test
|
|
60
|
+
end
|
|
52
61
|
end
|
|
53
62
|
|
|
54
63
|
|
data/lib/detroit-qedoc.rb
CHANGED
|
@@ -38,27 +38,29 @@ module Detroit
|
|
|
38
38
|
@output = output
|
|
39
39
|
end
|
|
40
40
|
|
|
41
|
-
# A S S E M B L Y - S T A T I O N S
|
|
42
41
|
|
|
43
|
-
#
|
|
44
|
-
def station_document
|
|
45
|
-
document
|
|
46
|
-
end
|
|
42
|
+
# A S S E M B L Y M E T H O D S
|
|
47
43
|
|
|
48
44
|
#
|
|
49
|
-
def
|
|
50
|
-
|
|
45
|
+
def assemble?(station, options={})
|
|
46
|
+
case station
|
|
47
|
+
when :document then true
|
|
48
|
+
when :reset then true
|
|
49
|
+
when :clean then true
|
|
50
|
+
when :purge then true
|
|
51
|
+
end
|
|
51
52
|
end
|
|
52
53
|
|
|
53
54
|
#
|
|
54
|
-
def
|
|
55
|
-
|
|
55
|
+
def assemble(station, options={})
|
|
56
|
+
case station
|
|
57
|
+
when :document then document
|
|
58
|
+
when :reset then reset
|
|
59
|
+
when :clean then clean
|
|
60
|
+
when :purge then purge
|
|
61
|
+
end
|
|
56
62
|
end
|
|
57
63
|
|
|
58
|
-
#
|
|
59
|
-
def station_purge
|
|
60
|
-
purge
|
|
61
|
-
end
|
|
62
64
|
|
|
63
65
|
# S E R V I C E M E T H O D S
|
|
64
66
|
|
data/man/detroit-qed.5
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
3
|
+
.
|
|
4
|
+
.TH "DETROIT\-QED" "5" "October 2011" "" ""
|
|
5
|
+
.
|
|
6
|
+
.SH "NAME"
|
|
7
|
+
\fBdetroit\-qed\fR \- run qed demonstrandum using detroit
|
|
8
|
+
.
|
|
9
|
+
.SH "DESCRIPTION"
|
|
10
|
+
The QED plug\-in for Detroit utilizes the QED test framework to run tests during the standard test phase\. It can also be used to unify QED demonstrandum into a single document suitable for inclusion in documentation\.
|
|
11
|
+
.
|
|
12
|
+
.P
|
|
13
|
+
This plug\-in package also includes detroit\-qedoc(5)\.
|
|
14
|
+
.
|
|
15
|
+
.SH "OPTIONS"
|
|
16
|
+
The following options can be used in the Detroit assembly file for defining a qed service\.
|
|
17
|
+
.
|
|
18
|
+
.IP "\(bu" 4
|
|
19
|
+
\fBfiles\fR \- Demonstrandum files to run (or globs there\-of)\.
|
|
20
|
+
.
|
|
21
|
+
.IP "\(bu" 4
|
|
22
|
+
\fBomit\fR \- File patterns to omit from \fBfiles\fR\.
|
|
23
|
+
.
|
|
24
|
+
.IP "\(bu" 4
|
|
25
|
+
\fBformat\fR \- Output format\.
|
|
26
|
+
.
|
|
27
|
+
.IP "\(bu" 4
|
|
28
|
+
\fBmode\fR \- Parse mode\.
|
|
29
|
+
.
|
|
30
|
+
.IP "\(bu" 4
|
|
31
|
+
\fBloadpath\fR \- Paths to be added to \fB$LOAD_PATH\fR\.
|
|
32
|
+
.
|
|
33
|
+
.IP "\(bu" 4
|
|
34
|
+
\fBrequires\fR \- Libraries to be required before running demonstrandum\.
|
|
35
|
+
.
|
|
36
|
+
.IP "\(bu" 4
|
|
37
|
+
\fBrooted\fR \- Operate from project root, instead of \fBtmp/qed\fR\.
|
|
38
|
+
.
|
|
39
|
+
.IP "\(bu" 4
|
|
40
|
+
\fBprofile\fR \- Select a profile\.
|
|
41
|
+
.
|
|
42
|
+
.IP "" 0
|
|
43
|
+
.
|
|
44
|
+
.SH "EXAMPLES"
|
|
45
|
+
The defaults are often sifficiant\. So an entry can be as simple as:
|
|
46
|
+
.
|
|
47
|
+
.IP "" 4
|
|
48
|
+
.
|
|
49
|
+
.nf
|
|
50
|
+
|
|
51
|
+
qed:
|
|
52
|
+
active: true
|
|
53
|
+
.
|
|
54
|
+
.fi
|
|
55
|
+
.
|
|
56
|
+
.IP "" 0
|
|
57
|
+
.
|
|
58
|
+
.P
|
|
59
|
+
A more typical example might be:
|
|
60
|
+
.
|
|
61
|
+
.IP "" 4
|
|
62
|
+
.
|
|
63
|
+
.nf
|
|
64
|
+
|
|
65
|
+
qed:
|
|
66
|
+
files: spec/
|
|
67
|
+
format: verbatim
|
|
68
|
+
.
|
|
69
|
+
.fi
|
|
70
|
+
.
|
|
71
|
+
.IP "" 0
|
|
72
|
+
.
|
|
73
|
+
.P
|
|
74
|
+
The above examples use the YAML\-base assembly format\. Assembly files can also be Ruby\-based\. See Detroit documentation for more details\.
|
|
75
|
+
.
|
|
76
|
+
.SH "RESOURCES"
|
|
77
|
+
For more information:
|
|
78
|
+
.
|
|
79
|
+
.IP "\(bu" 4
|
|
80
|
+
API Documentation \fIhttp://rubydoc\.info/gems/detroit\-qed\fR
|
|
81
|
+
.
|
|
82
|
+
.IP "\(bu" 4
|
|
83
|
+
Development Site \fIhttp://github\.com/detroit/detroit\-qed\fR
|
|
84
|
+
.
|
|
85
|
+
.IP "" 0
|
|
86
|
+
.
|
|
87
|
+
.SH "COPYRIGHT"
|
|
88
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
89
|
+
.
|
|
90
|
+
.P
|
|
91
|
+
Detroit QED is distributable in accordance with the GPLv3 license\.
|
|
92
|
+
.
|
|
93
|
+
.SH "SEE ALSO"
|
|
94
|
+
detroit(1), qed(1), detroit\-qedoc(5)
|
|
@@ -0,0 +1,150 @@
|
|
|
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-qed(5) - run qed demonstrandum using 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-qed(5)</li>
|
|
67
|
+
<li class='tc'></li>
|
|
68
|
+
<li class='tr'>detroit-qed(5)</li>
|
|
69
|
+
</ol>
|
|
70
|
+
|
|
71
|
+
<h2 id="NAME">NAME</h2>
|
|
72
|
+
<p class="man-name">
|
|
73
|
+
<code>detroit-qed</code> - <span class="man-whatis">run qed demonstrandum using detroit</span>
|
|
74
|
+
</p>
|
|
75
|
+
|
|
76
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
77
|
+
|
|
78
|
+
<p>The QED plug-in for Detroit utilizes the QED test framework
|
|
79
|
+
to run tests during the standard test phase. It can also be used
|
|
80
|
+
to unify QED demonstrandum into a single document suitable for
|
|
81
|
+
inclusion in documentation.</p>
|
|
82
|
+
|
|
83
|
+
<p>This plug-in package also includes <a href="detroit-qedoc.5.html" class="man-ref">detroit-qedoc<span class="s">(5)</span></a>.</p>
|
|
84
|
+
|
|
85
|
+
<h2 id="OPTIONS">OPTIONS</h2>
|
|
86
|
+
|
|
87
|
+
<p>The following options can be used in the Detroit assembly file
|
|
88
|
+
for defining a qed service.</p>
|
|
89
|
+
|
|
90
|
+
<ul>
|
|
91
|
+
<li><p><code>files</code> - Demonstrandum files to run (or globs there-of).</p></li>
|
|
92
|
+
<li><p><code>omit</code> - File patterns to omit from <code>files</code>.</p></li>
|
|
93
|
+
<li><p><code>format</code> - Output format.</p></li>
|
|
94
|
+
<li><p><code>mode</code> - Parse mode.</p></li>
|
|
95
|
+
<li><p><code>loadpath</code> - Paths to be added to <code>$LOAD_PATH</code>.</p></li>
|
|
96
|
+
<li><p><code>requires</code> - Libraries to be required before running demonstrandum.</p></li>
|
|
97
|
+
<li><p><code>rooted</code> - Operate from project root, instead of <code>tmp/qed</code>.</p></li>
|
|
98
|
+
<li><p><code>profile</code> - Select a profile.</p></li>
|
|
99
|
+
</ul>
|
|
100
|
+
|
|
101
|
+
|
|
102
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
103
|
+
|
|
104
|
+
<p>The defaults are often sifficiant. So an entry can be as simple as:</p>
|
|
105
|
+
|
|
106
|
+
<pre><code>qed:
|
|
107
|
+
active: true
|
|
108
|
+
</code></pre>
|
|
109
|
+
|
|
110
|
+
<p>A more typical example might be:</p>
|
|
111
|
+
|
|
112
|
+
<pre><code>qed:
|
|
113
|
+
files: spec/
|
|
114
|
+
format: verbatim
|
|
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
|
+
<p>For more information:</p>
|
|
124
|
+
|
|
125
|
+
<ul>
|
|
126
|
+
<li><p><a href="http://rubydoc.info/gems/detroit-qed">API Documentation</a></p></li>
|
|
127
|
+
<li><p><a href="http://github.com/detroit/detroit-qed">Development Site</a></p></li>
|
|
128
|
+
</ul>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
<h2 id="COPYRIGHT">COPYRIGHT</h2>
|
|
132
|
+
|
|
133
|
+
<p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
|
|
134
|
+
|
|
135
|
+
<p>Detroit QED is distributable in accordance with the GPLv3 license.</p>
|
|
136
|
+
|
|
137
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
138
|
+
|
|
139
|
+
<p><span class="man-ref">detroit<span class="s">(1)</span></span>, <span class="man-ref">qed<span class="s">(1)</span></span>, <a href="detroit-qedoc.5.html" class="man-ref">detroit-qedoc<span class="s">(5)</span></a></p>
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
<ol class='man-decor man-foot man foot'>
|
|
143
|
+
<li class='tl'></li>
|
|
144
|
+
<li class='tc'>October 2011</li>
|
|
145
|
+
<li class='tr'>detroit-qed(5)</li>
|
|
146
|
+
</ol>
|
|
147
|
+
|
|
148
|
+
</div>
|
|
149
|
+
</body>
|
|
150
|
+
</html>
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
detroit-qed(5) - run qed demonstrandum using detroit
|
|
2
|
+
====================================================
|
|
3
|
+
|
|
4
|
+
## DESCRIPTION
|
|
5
|
+
|
|
6
|
+
The QED plug-in for Detroit utilizes the QED test framework
|
|
7
|
+
to run tests during the standard test phase. It can also be used
|
|
8
|
+
to unify QED demonstrandum into a single document suitable for
|
|
9
|
+
inclusion in documentation.
|
|
10
|
+
|
|
11
|
+
This plug-in package also includes detroit-qedoc(5).
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## OPTIONS
|
|
15
|
+
|
|
16
|
+
The following options can be used in the Detroit assembly file
|
|
17
|
+
for defining a qed service.
|
|
18
|
+
|
|
19
|
+
* `files` - Demonstrandum files to run (or globs there-of).
|
|
20
|
+
|
|
21
|
+
* `omit` - File patterns to omit from `files`.
|
|
22
|
+
|
|
23
|
+
* `format` - Output format.
|
|
24
|
+
|
|
25
|
+
* `mode` - Parse mode.
|
|
26
|
+
|
|
27
|
+
* `loadpath` - Paths to be added to `$LOAD_PATH`.
|
|
28
|
+
|
|
29
|
+
* `requires` - Libraries to be required before running demonstrandum.
|
|
30
|
+
|
|
31
|
+
* `rooted` - Operate from project root, instead of `tmp/qed`.
|
|
32
|
+
|
|
33
|
+
* `profile` - Select a profile.
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
## EXAMPLES
|
|
37
|
+
|
|
38
|
+
The defaults are often sifficiant. So an entry can be as simple as:
|
|
39
|
+
|
|
40
|
+
qed:
|
|
41
|
+
active: true
|
|
42
|
+
|
|
43
|
+
A more typical example might be:
|
|
44
|
+
|
|
45
|
+
qed:
|
|
46
|
+
files: spec/
|
|
47
|
+
format: verbatim
|
|
48
|
+
|
|
49
|
+
The above examples use the YAML-base assembly format. Assembly
|
|
50
|
+
files can also be Ruby-based. See Detroit documentation for more
|
|
51
|
+
details.
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
## RESOURCES
|
|
55
|
+
|
|
56
|
+
For more information:
|
|
57
|
+
|
|
58
|
+
* [API Documentation](http://rubydoc.info/gems/detroit-qed)
|
|
59
|
+
|
|
60
|
+
* [Development Site](http://github.com/detroit/detroit-qed)
|
|
61
|
+
|
|
62
|
+
|
|
63
|
+
## COPYRIGHT
|
|
64
|
+
|
|
65
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
66
|
+
|
|
67
|
+
Detroit QED is distributable in accordance with the GPLv3 license.
|
|
68
|
+
|
|
69
|
+
|
|
70
|
+
## SEE ALSO
|
|
71
|
+
|
|
72
|
+
detroit(1), qed(1), detroit-qedoc(5)
|
data/man/detroit-qedoc.5
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
.\" generated with Ronn/v0.7.3
|
|
2
|
+
.\" http://github.com/rtomayko/ronn/tree/0.7.3
|
|
3
|
+
.
|
|
4
|
+
.TH "DETROIT\-QEDOC" "5" "October 2011" "" ""
|
|
5
|
+
.
|
|
6
|
+
.SH "NAME"
|
|
7
|
+
\fBdetroit\-qedoc\fR \- document qed demonstrandum using detroit
|
|
8
|
+
.
|
|
9
|
+
.SH "DESCRIPTION"
|
|
10
|
+
The QEDoc plug\-in for Detroit utilizes the QED test framework to unify QED demonstrandum into a single document suitable for inclusion in documentation\.
|
|
11
|
+
.
|
|
12
|
+
.P
|
|
13
|
+
This plug\-in is included in the \fBdetroit\-qed\fR package, along with the detroit\-qed(5) test plug\-in\.
|
|
14
|
+
.
|
|
15
|
+
.SH "OPTIONS"
|
|
16
|
+
The following options can be used in the Detroit assembly file for defining a QED service\.
|
|
17
|
+
.
|
|
18
|
+
.IP "\(bu" 4
|
|
19
|
+
\fBfiles\fR \- Demonstrandum files to document (or globs there\-of)\.
|
|
20
|
+
.
|
|
21
|
+
.IP "\(bu" 4
|
|
22
|
+
\fBtitle\fR \- Optional title to use in generate document\.
|
|
23
|
+
.
|
|
24
|
+
.IP "\(bu" 4
|
|
25
|
+
\fBoutput\fR \- Output file(s) to generate QEDocs\. The file\'s extension name determines the output format\.
|
|
26
|
+
.
|
|
27
|
+
.IP "\(bu" 4
|
|
28
|
+
\fBstylesheet\fR \- Relative reference to css stylesheet for QEDocs\. This is only useful to the HTML format\.
|
|
29
|
+
.
|
|
30
|
+
.IP "" 0
|
|
31
|
+
.
|
|
32
|
+
.SH "EXAMPLES"
|
|
33
|
+
Option defaults are fairly typical\. So the simplest entry is something like:
|
|
34
|
+
.
|
|
35
|
+
.IP "" 4
|
|
36
|
+
.
|
|
37
|
+
.nf
|
|
38
|
+
|
|
39
|
+
qedoc:
|
|
40
|
+
output:
|
|
41
|
+
\- SPEC\.rdoc
|
|
42
|
+
.
|
|
43
|
+
.fi
|
|
44
|
+
.
|
|
45
|
+
.IP "" 0
|
|
46
|
+
.
|
|
47
|
+
.P
|
|
48
|
+
A more complex example might be something like:
|
|
49
|
+
.
|
|
50
|
+
.IP "" 4
|
|
51
|
+
.
|
|
52
|
+
.nf
|
|
53
|
+
|
|
54
|
+
qedoc:
|
|
55
|
+
title: In Depth with MyApp
|
|
56
|
+
files: qed/
|
|
57
|
+
output:
|
|
58
|
+
\- QED\.rdoc
|
|
59
|
+
.
|
|
60
|
+
.fi
|
|
61
|
+
.
|
|
62
|
+
.IP "" 0
|
|
63
|
+
.
|
|
64
|
+
.P
|
|
65
|
+
The above examples use the YAML\-base assembly format\. Assembly files can also be Ruby\-based\. See Detroit documentation for more details\.
|
|
66
|
+
.
|
|
67
|
+
.SH "COPYRIGHT"
|
|
68
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
69
|
+
.
|
|
70
|
+
.P
|
|
71
|
+
Detroit QED is distributable in accordance with the GPLv3 license\.
|
|
72
|
+
.
|
|
73
|
+
.SH "SEE ALSO"
|
|
74
|
+
detroit(1), qed(1), detroit\-qed(5)
|
|
@@ -0,0 +1,140 @@
|
|
|
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-qedoc(5) - document qed demonstrandum using 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="#COPYRIGHT">COPYRIGHT</a>
|
|
61
|
+
<a href="#SEE-ALSO">SEE ALSO</a>
|
|
62
|
+
</div>
|
|
63
|
+
|
|
64
|
+
<ol class='man-decor man-head man head'>
|
|
65
|
+
<li class='tl'>detroit-qedoc(5)</li>
|
|
66
|
+
<li class='tc'></li>
|
|
67
|
+
<li class='tr'>detroit-qedoc(5)</li>
|
|
68
|
+
</ol>
|
|
69
|
+
|
|
70
|
+
<h2 id="NAME">NAME</h2>
|
|
71
|
+
<p class="man-name">
|
|
72
|
+
<code>detroit-qedoc</code> - <span class="man-whatis">document qed demonstrandum using detroit</span>
|
|
73
|
+
</p>
|
|
74
|
+
|
|
75
|
+
<h2 id="DESCRIPTION">DESCRIPTION</h2>
|
|
76
|
+
|
|
77
|
+
<p>The QEDoc plug-in for Detroit utilizes the QED test framework
|
|
78
|
+
to unify QED demonstrandum into a single document suitable for
|
|
79
|
+
inclusion in documentation.</p>
|
|
80
|
+
|
|
81
|
+
<p>This plug-in is included in the <code>detroit-qed</code> package, along with
|
|
82
|
+
the <a href="detroit-qed.5.html" class="man-ref">detroit-qed<span class="s">(5)</span></a> test 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
|
+
for defining a QED service.</p>
|
|
88
|
+
|
|
89
|
+
<ul>
|
|
90
|
+
<li><p><code>files</code> - Demonstrandum files to document (or globs there-of).</p></li>
|
|
91
|
+
<li><p><code>title</code> - Optional title to use in generate document.</p></li>
|
|
92
|
+
<li><p><code>output</code> - Output file(s) to generate QEDocs. The file's extension
|
|
93
|
+
name determines the output format.</p></li>
|
|
94
|
+
<li><p><code>stylesheet</code> - Relative reference to css stylesheet for QEDocs.
|
|
95
|
+
This is only useful to the HTML format.</p></li>
|
|
96
|
+
</ul>
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
<h2 id="EXAMPLES">EXAMPLES</h2>
|
|
100
|
+
|
|
101
|
+
<p>Option defaults are fairly typical. So the simplest entry is something like:</p>
|
|
102
|
+
|
|
103
|
+
<pre><code>qedoc:
|
|
104
|
+
output:
|
|
105
|
+
- SPEC.rdoc
|
|
106
|
+
</code></pre>
|
|
107
|
+
|
|
108
|
+
<p>A more complex example might be something like:</p>
|
|
109
|
+
|
|
110
|
+
<pre><code>qedoc:
|
|
111
|
+
title: In Depth with MyApp
|
|
112
|
+
files: qed/
|
|
113
|
+
output:
|
|
114
|
+
- QED.rdoc
|
|
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="COPYRIGHT">COPYRIGHT</h2>
|
|
122
|
+
|
|
123
|
+
<p>Copyright (c) 2010 Thomas Sawyer, Rubyworks</p>
|
|
124
|
+
|
|
125
|
+
<p>Detroit QED is distributable in accordance with the GPLv3 license.</p>
|
|
126
|
+
|
|
127
|
+
<h2 id="SEE-ALSO">SEE ALSO</h2>
|
|
128
|
+
|
|
129
|
+
<p><span class="man-ref">detroit<span class="s">(1)</span></span>, <span class="man-ref">qed<span class="s">(1)</span></span>, <a href="detroit-qed.5.html" class="man-ref">detroit-qed<span class="s">(5)</span></a></p>
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
<ol class='man-decor man-foot man foot'>
|
|
133
|
+
<li class='tl'></li>
|
|
134
|
+
<li class='tc'>October 2011</li>
|
|
135
|
+
<li class='tr'>detroit-qedoc(5)</li>
|
|
136
|
+
</ol>
|
|
137
|
+
|
|
138
|
+
</div>
|
|
139
|
+
</body>
|
|
140
|
+
</html>
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
detroit-qedoc(5) - document qed demonstrandum using detroit
|
|
2
|
+
===========================================================
|
|
3
|
+
|
|
4
|
+
## DESCRIPTION
|
|
5
|
+
|
|
6
|
+
The QEDoc plug-in for Detroit utilizes the QED test framework
|
|
7
|
+
to unify QED demonstrandum into a single document suitable for
|
|
8
|
+
inclusion in documentation.
|
|
9
|
+
|
|
10
|
+
This plug-in is included in the `detroit-qed` package, along with
|
|
11
|
+
the detroit-qed(5) test plug-in.
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
## OPTIONS
|
|
15
|
+
|
|
16
|
+
The following options can be used in the Detroit assembly file
|
|
17
|
+
for defining a QED service.
|
|
18
|
+
|
|
19
|
+
* `files` - Demonstrandum files to document (or globs there-of).
|
|
20
|
+
|
|
21
|
+
* `title` - Optional title to use in generate document.
|
|
22
|
+
|
|
23
|
+
* `output` - Output file(s) to generate QEDocs. The file's extension
|
|
24
|
+
name determines the output format.
|
|
25
|
+
|
|
26
|
+
* `stylesheet` - Relative reference to css stylesheet for QEDocs.
|
|
27
|
+
This is only useful to the HTML format.
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
## EXAMPLES
|
|
31
|
+
|
|
32
|
+
Option defaults are fairly typical. So the simplest entry is something like:
|
|
33
|
+
|
|
34
|
+
qedoc:
|
|
35
|
+
output:
|
|
36
|
+
- SPEC.rdoc
|
|
37
|
+
|
|
38
|
+
A more complex example might be something like:
|
|
39
|
+
|
|
40
|
+
qedoc:
|
|
41
|
+
title: In Depth with MyApp
|
|
42
|
+
files: qed/
|
|
43
|
+
output:
|
|
44
|
+
- QED.rdoc
|
|
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
|
+
## COPYRIGHT
|
|
52
|
+
|
|
53
|
+
Copyright (c) 2010 Thomas Sawyer, Rubyworks
|
|
54
|
+
|
|
55
|
+
Detroit QED is distributable in accordance with the GPLv3 license.
|
|
56
|
+
|
|
57
|
+
|
|
58
|
+
## SEE ALSO
|
|
59
|
+
|
|
60
|
+
detroit(1), qed(1), detroit-qed(5)
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: detroit-qed
|
|
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,11 +9,22 @@ authors:
|
|
|
9
9
|
autorequire:
|
|
10
10
|
bindir: bin
|
|
11
11
|
cert_chain: []
|
|
12
|
-
date:
|
|
12
|
+
date: 2012-04-02 00:00:00.000000000 Z
|
|
13
13
|
dependencies:
|
|
14
14
|
- !ruby/object:Gem::Dependency
|
|
15
15
|
name: detroit
|
|
16
|
-
requirement: &
|
|
16
|
+
requirement: &30958600 !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: *30958600
|
|
25
|
+
- !ruby/object:Gem::Dependency
|
|
26
|
+
name: qed
|
|
27
|
+
requirement: &30958060 !ruby/object:Gem::Requirement
|
|
17
28
|
none: false
|
|
18
29
|
requirements:
|
|
19
30
|
- - ! '>='
|
|
@@ -21,7 +32,7 @@ dependencies:
|
|
|
21
32
|
version: '0'
|
|
22
33
|
type: :runtime
|
|
23
34
|
prerelease: false
|
|
24
|
-
version_requirements: *
|
|
35
|
+
version_requirements: *30958060
|
|
25
36
|
description: QED plugin for Detroit build system. This plugin will run QED specs
|
|
26
37
|
during the test phase and can create a unified spec document during documentation
|
|
27
38
|
phase.
|
|
@@ -30,18 +41,25 @@ email:
|
|
|
30
41
|
executables: []
|
|
31
42
|
extensions: []
|
|
32
43
|
extra_rdoc_files:
|
|
33
|
-
-
|
|
44
|
+
- LICENSE.txt
|
|
34
45
|
- README.rdoc
|
|
35
46
|
- COPYING.rdoc
|
|
36
47
|
files:
|
|
37
48
|
- .ruby
|
|
38
49
|
- lib/detroit-qed.rb
|
|
39
50
|
- lib/detroit-qedoc.rb
|
|
51
|
+
- man/detroit-qed.5
|
|
52
|
+
- man/detroit-qed.5.html
|
|
53
|
+
- man/detroit-qed.5.ronn
|
|
54
|
+
- man/detroit-qedoc.5
|
|
55
|
+
- man/detroit-qedoc.5.html
|
|
56
|
+
- man/detroit-qedoc.5.ronn
|
|
57
|
+
- LICENSE.txt
|
|
40
58
|
- README.rdoc
|
|
41
|
-
- GPL3.txt
|
|
42
59
|
- COPYING.rdoc
|
|
43
60
|
homepage: http://detroit.github.com/
|
|
44
|
-
licenses:
|
|
61
|
+
licenses:
|
|
62
|
+
- GPL3
|
|
45
63
|
post_install_message:
|
|
46
64
|
rdoc_options: []
|
|
47
65
|
require_paths:
|
|
@@ -60,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
60
78
|
version: '0'
|
|
61
79
|
requirements: []
|
|
62
80
|
rubyforge_project:
|
|
63
|
-
rubygems_version: 1.8.
|
|
81
|
+
rubygems_version: 1.8.11
|
|
64
82
|
signing_key:
|
|
65
83
|
specification_version: 3
|
|
66
84
|
summary: QED plugin for Detroit
|