Converts doc files to dash docsets.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
lib
rakelib
spec
.gitignore
Dockerfile
Gemfile
LICENSE.txt
README.md
Rakefile
default_icon.png
doc_to_dash.gemspec
release.sh

README.md

DocToDash

DocToDash converts documentation files (Rdoc Darkfish / YARD) into a classes and methods docset that can then be loaded into the docset viewing program: Dash.

Installation

Add this line to your application's Gemfile:

gem 'doc_to_dash'

And then execute:

$ bundle

Or install it yourself as:

$ gem install doc_to_dash

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

<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>../default_icon.png</td>
    <td>The icon file that will be put in the docset.  Shown in Dash.</td>
    <td>No (can be nil, will not transfer default_icon.png)</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.  DocToDash::YardParser / DocToDash::RdocDarkfishParser.</td>
    <td>Yes</td>
</tr>
Key Default Description Required

Command Line

doc_to_dash [options] <doc_directory_path>

Options

<tr>
    <td>--icon</td>
    <td>-i</td>
    <td>Docset icon which will display in Dash.</td>
</tr>

<tr>
    <td>--name</td>
    <td>-n</td>
    <td>Docset name which will display in Dash.</td>
</tr>

<tr>
    <td>--output</td>
    <td>-o</td>
    <td>Docset Output Path where the docset will be saved.</td>
</tr>

<tr>
    <td>--parser</td>
    <td>-p</td>
    <td>Parser to use (YardParser / RdocDarkfishParser)</td>
</tr>

<tr>
    <td>--help</td>
    <td>-h</td>
    <td>Show help message</td>
</tr>
Option Short Description

Contributing

  1. Fork it
  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

Thanks

Default Icon: Crash Test Dummy designed by Luis Prado from The Noun Project