doc_to_dash 0.0.7 → 0.0.8

data/README.md

@@ -16,7 +16,25 @@ Or install it yourself as:
 
     $ gem install doc_to_dash
 
-## Options
+## Usage
+
+Generate YARD documentation (or darkfish rdoc). This below will output your Rails application's YARD documentation to doc/yard:
+
+    $ yardoc app/**/*.rb lib/**/*.rb --protected --private --embed-mixins --output-dir doc/yard/
+
+### Code
+
+Require doc_to_dash
+
+    require 'doc_to_dash'
+
+Tell doc_to_dash to generate a docset:
+
+    DocToDash::DocsetGenerator.new(:doc_input_path => '/web/myapp/doc/yard').run
+
+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.
+
+#### Options
 
 <table>
     <tr>
@@ -76,25 +94,49 @@ Or install it yourself as:
     </tr>
 </table>
 
-## Usage
+### Command Line
 
-Generate YARD documentation (or darkfish rdoc). This below will output your Rails application's YARD documentation to doc/yard:
+    doc_to_dash [options] <doc_directory_path>
 
-    $ yardoc app/**/*.rb lib/**/*.rb --protected --private --embed-mixins --output-dir doc/yard/
+#### Options
 
-Require doc_to_dash
-
-    require 'doc_to_dash'
+<table>
+    <tr>
+        <th>Option</th>
+        <th>Short</th>
+        <th>Description</th>
+    </tr>
 
-Tell doc_to_dash to generate a docset:
+    <tr>
+        <td>--icon</td>
+        <td>-i</td>
+        <td>Docset icon which will display in Dash.</td>
+    </tr>
 
-    DocToDash::DocsetGenerator.new(:docset_name => 'MyApplication', :doc_input_path => '/web/myapp/doc/yard', :icon_path => '~/icon.png', :docset_output_path => '/users/test/docsets').run
+    <tr>
+        <td>--name</td>
+        <td>-n</td>
+        <td>Docset name which will display in Dash.</td>
+    </tr>
 
-This will create a docset in the docset_output_path then you just need to load the docset into Dash.
+    <tr>
+        <td>--output</td>
+        <td>-o</td>
+        <td>Docset Output Path where the docset will be saved.</td>
+    </tr>
 
-### Command Line
+    <tr>
+        <td>--parser</td>
+        <td>-p</td>
+        <td>Parser to use (YardParser / RdocDarkfishParser)</td>
+    </tr>
 
-    doc_to_dash [docset_name] [input_docs_path] [output_docset]
+    <tr>
+        <td>--help</td>
+        <td>-h</td>
+        <td>Show help message</td>
+    </tr>
+</table>
 
 ## Contributing
 

data/lib/doc_to_dash.rb

@@ -151,6 +151,8 @@ module DocToDash
           <string>{DOCSET_NAME}</string>
           <key>isDashDocset</key>
           <true/>
+          <key>dashIndexFilePath</key>
+          <string>#{@options[:doc_save_folder]}/index.html</string>
         </dict>
         </plist>
 XML

data/lib/doc_to_dash/cli.rb

@@ -10,7 +10,7 @@ module DocToDash
       @opts = Trollop::options do
         banner DocToDash::CLI.banner_data
         opt :icon,    "Docset icon which will display in Dash.",            :type => :string
-        opt :name,    "Docset name which will dispaly in Dash.",            :type => :string
+        opt :name,    "Docset name which will display in Dash.",            :type => :string
         opt :output,  "Docset Output Path where the docset will be saved.", :type => :string
         opt :parser,  "Docset parser to use.",                              :type => :string
       end

data/lib/doc_to_dash/version.rb

@@ -1,3 +1,3 @@
 module DocToDash
-  VERSION = "0.0.7"
-end
+  VERSION = "0.0.8"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_to_dash
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-18 00:00:00.000000000 Z
+date: 2012-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri