doc_to_dash 0.0.7 → 0.0.8
Sign up to get free protection for your applications and to get access to all the features.
- data/README.md +54 -12
- data/lib/doc_to_dash.rb +2 -0
- data/lib/doc_to_dash/cli.rb +1 -1
- data/lib/doc_to_dash/version.rb +2 -2
- metadata +2 -2
data/README.md
CHANGED
@@ -16,7 +16,25 @@ Or install it yourself as:
|
|
16
16
|
|
17
17
|
$ gem install doc_to_dash
|
18
18
|
|
19
|
-
##
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
Generate YARD documentation (or darkfish rdoc). This below will output your Rails application's YARD documentation to doc/yard:
|
22
|
+
|
23
|
+
$ yardoc app/**/*.rb lib/**/*.rb --protected --private --embed-mixins --output-dir doc/yard/
|
24
|
+
|
25
|
+
### Code
|
26
|
+
|
27
|
+
Require doc_to_dash
|
28
|
+
|
29
|
+
require 'doc_to_dash'
|
30
|
+
|
31
|
+
Tell doc_to_dash to generate a docset:
|
32
|
+
|
33
|
+
DocToDash::DocsetGenerator.new(:doc_input_path => '/web/myapp/doc/yard').run
|
34
|
+
|
35
|
+
This will create a docset in doc/DefaultDocset.docset then you just need to load the docset into Dash. The options above can be passed.
|
36
|
+
|
37
|
+
#### Options
|
20
38
|
|
21
39
|
<table>
|
22
40
|
<tr>
|
@@ -76,25 +94,49 @@ Or install it yourself as:
|
|
76
94
|
</tr>
|
77
95
|
</table>
|
78
96
|
|
79
|
-
|
97
|
+
### Command Line
|
80
98
|
|
81
|
-
|
99
|
+
doc_to_dash [options] <doc_directory_path>
|
82
100
|
|
83
|
-
|
101
|
+
#### Options
|
84
102
|
|
85
|
-
|
86
|
-
|
87
|
-
|
103
|
+
<table>
|
104
|
+
<tr>
|
105
|
+
<th>Option</th>
|
106
|
+
<th>Short</th>
|
107
|
+
<th>Description</th>
|
108
|
+
</tr>
|
88
109
|
|
89
|
-
|
110
|
+
<tr>
|
111
|
+
<td>--icon</td>
|
112
|
+
<td>-i</td>
|
113
|
+
<td>Docset icon which will display in Dash.</td>
|
114
|
+
</tr>
|
90
115
|
|
91
|
-
|
116
|
+
<tr>
|
117
|
+
<td>--name</td>
|
118
|
+
<td>-n</td>
|
119
|
+
<td>Docset name which will display in Dash.</td>
|
120
|
+
</tr>
|
92
121
|
|
93
|
-
|
122
|
+
<tr>
|
123
|
+
<td>--output</td>
|
124
|
+
<td>-o</td>
|
125
|
+
<td>Docset Output Path where the docset will be saved.</td>
|
126
|
+
</tr>
|
94
127
|
|
95
|
-
|
128
|
+
<tr>
|
129
|
+
<td>--parser</td>
|
130
|
+
<td>-p</td>
|
131
|
+
<td>Parser to use (YardParser / RdocDarkfishParser)</td>
|
132
|
+
</tr>
|
96
133
|
|
97
|
-
|
134
|
+
<tr>
|
135
|
+
<td>--help</td>
|
136
|
+
<td>-h</td>
|
137
|
+
<td>Show help message</td>
|
138
|
+
</tr>
|
139
|
+
</table>
|
98
140
|
|
99
141
|
## Contributing
|
100
142
|
|
data/lib/doc_to_dash.rb
CHANGED
data/lib/doc_to_dash/cli.rb
CHANGED
@@ -10,7 +10,7 @@ module DocToDash
|
|
10
10
|
@opts = Trollop::options do
|
11
11
|
banner DocToDash::CLI.banner_data
|
12
12
|
opt :icon, "Docset icon which will display in Dash.", :type => :string
|
13
|
-
opt :name, "Docset name which will
|
13
|
+
opt :name, "Docset name which will display in Dash.", :type => :string
|
14
14
|
opt :output, "Docset Output Path where the docset will be saved.", :type => :string
|
15
15
|
opt :parser, "Docset parser to use.", :type => :string
|
16
16
|
end
|
data/lib/doc_to_dash/version.rb
CHANGED
@@ -1,3 +1,3 @@
|
|
1
1
|
module DocToDash
|
2
|
-
VERSION = "0.0.
|
3
|
-
end
|
2
|
+
VERSION = "0.0.8"
|
3
|
+
end
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: doc_to_dash
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.0.
|
4
|
+
version: 0.0.8
|
5
5
|
prerelease:
|
6
6
|
platform: ruby
|
7
7
|
authors:
|
@@ -9,7 +9,7 @@ authors:
|
|
9
9
|
autorequire:
|
10
10
|
bindir: bin
|
11
11
|
cert_chain: []
|
12
|
-
date: 2012-
|
12
|
+
date: 2012-11-05 00:00:00.000000000 Z
|
13
13
|
dependencies:
|
14
14
|
- !ruby/object:Gem::Dependency
|
15
15
|
name: nokogiri
|