RDoc generator that turns ruby documentation into Dictionary.app file on Mac.
Pull request Compare This branch is 5 commits behind priithaamer:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
lib
.gitignore
Gemfile
README.markdown
Rakefile
rubydictionary.gemspec

README.markdown

This gem adds rubydictionary formatter to RDoc.

Prerequisites

You will need latest Xcode developer tools.

Install

gem install rubydictionary

Building dictionary

Run rubydictionary in your source code directory. For example for source of Sinatra:

rubydictionary --dict-name=Sinatra --dict-id=com.sinatrarb.Dictionary

If all goes well, you should now have Sinatra.dictionary file under ./doc/objects directory. Drop it into ~/Library/Dictionaries/ folder.

Authors

See the Github contributors page.

Links