doc_to_dash 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # DocToDash
 
-TODO: Write a gem description
+DocToDash converts documentation files (at the moment only YARD) into a classes and methods docset that can then be loaded into the docset viewing program: Dash.
 
 ## Installation
 
@@ -16,9 +16,81 @@ Or install it yourself as:
 
     $ gem install doc_to_dash
 
+## Options
+
+<table>
+    <tr>
+        <th>Key</th>
+        <th>Default</th>
+        <th>Description</th>
+        <th>Required</th>
+    </tr>
+
+    <tr>
+        <td>:docset_name</td>
+        <td>DefaultDocset</td>
+        <td>What the file will be called.  EX: DefaultDocset.docset</td>
+        <td>Yes</td>
+    </tr>
+
+    <tr>
+        <td>:docset_output_path</td>
+        <td>doc/</td>
+        <td>Where the file above will be stored EX: doc/DefaultDocset.docset</td>
+        <td>Yes</td>
+    </tr>
+
+    <tr>
+        <td>:icon_path</td>
+        <td>nil/</td>
+        <td>The icon file that will be put in the docset.  Shown in Dash.</td>
+        <td>No</td>
+    </tr>
+
+    <tr>
+        <td>:doc_input_path</td>
+        <td>nil/</td>
+        <td>The directory that the doc files will be coming from.  EX: /Users/Caleb/web/my_site/doc/yard</td>
+        <td>Yes</td>
+    </tr>
+
+    <tr>
+        <td>:doc_save_folder</td>
+        <td>docs/</td>
+        <td>Where inside the docset the docs will be copied to (not really important, just here if you need to change it)</td>
+        <td>Yes</td>
+    </tr>
+
+    <tr>
+        <td>:verbose</td>
+        <td>true</td>
+        <td>Spits out messages with "puts" showing what is going on.</td>
+        <td>Yes</td>
+    </tr>
+
+    <tr>
+        <td>:parser</td>
+        <td>DocToDash::YardParser</td>
+        <td>Parser to use to pull out classes and modules.  YARD is only supported at the moment.</td>
+        <td>Yes</td>
+    </tr>
+</table>
+
 ## Usage
 
-TODO: Write usage instructions here
+Generate YARD documentation (or as time progresses and we support rdoc, generate that). This will output your Rails application's YARD documentation to doc/yard:
+
+    $ yardoc app/**/*.rb lib/**/*.rb --protected --private --embed-mixins --output-dir doc/yard/
+
+Require doc_to_dash
+
+    require 'doc_to_dash'
+
+Tell doc_to_dash to generate a docset:
+
+    DocToDash::DocsetGenerator.new(:docset_name => 'MyApplication', :doc_input_path => '/web/myapp/doc/yard', :icon_path => '~/icon.png', :docset_output_path => '/users/test/docsets').run
+
+This will create a docset in the docset_output_path then you just need to load the docset into Dash.
 
 ## Contributing
 
@@ -26,4 +98,4 @@ TODO: Write usage instructions here
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+5. Create new Pull Request

data/bin/doc_to_dash

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'doc_to_dash'
+
+# Need to do some cool command line switches here instead of this usage
+# Need to incorporate icon, etc in.
+
+if ARGV.count < 3
+  puts "Usage: doc_to_dash [docset_name] [input_docs_path] [output_docset]"
+  exit
+end
+
+DocToDash::DocsetGenerator.new(:docset_name => ARGV[0], :docset_output_path => ARGV[2], :doc_input_path => ARGV[1]).run

data/doc_to_dash.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["me@caleb.io"]
   gem.description   = "Converts documentation to a Dash Docset"
   gem.summary       = "Documentation to Dash Docset Converter"
-  gem.homepage      = ""
+  gem.homepage      = "https://rubygems.org/gems/doc_to_dash"
 
   gem.files         = `git ls-files`.split($/)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
@@ -19,4 +19,6 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency "nokogiri"
   gem.add_dependency "sqlite3"
+
+  gem.executables   << 'doc_to_dash'
 end

data/lib/doc_to_dash/version.rb

@@ -1,3 +1,3 @@
 module DocToDash
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: doc_to_dash
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -46,7 +46,8 @@ dependencies:
 description: Converts documentation to a Dash Docset
 email:
 - me@caleb.io
-executables: []
+executables:
+- doc_to_dash
 extensions: []
 extra_rdoc_files: []
 files:
@@ -55,11 +56,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/doc_to_dash
 - doc_to_dash.gemspec
 - lib/doc_to_dash.rb
 - lib/doc_to_dash/version.rb
 - lib/doc_to_dash/yard_parser.rb
-homepage: ''
+homepage: https://rubygems.org/gems/doc_to_dash
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -84,3 +86,4 @@ signing_key:
 specification_version: 3
 summary: Documentation to Dash Docset Converter
 test_files: []
+has_rdoc: