0.02
No commit activity in last 3 years
No release in over 3 years
Builds dictionary files for Mac OS Dictionary.app of Ruby documentation using RDoc
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
 Dependencies

Development

>= 0
 Project Readme

This gem adds rubydictionary formatter to RDoc.

Prerequisites

You will need latest Command Line Tools for Xcode.

Dictionary Development Kit

Since OS X Mountain Lion, Dictionary Development Kit required to build dictionaries is not included by default with developer tools.

Dictionary Development Kit can be downloaded from Downloads for Apple Developers page and it is inside Auxiliary Tools for Xcode package. You must copy Dictionary Development Kit manually to /Developer/Extras folder.

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 everything goes well, you should now have Sinatra.dictionary file under ./doc/objects directory. Drop it into ~/Library/Dictionaries/ folder.

If Dictionary Development Kit is located somewhere else than in /Developer/Extras (which is recommended in 10.9+), you can specify the path for it with --kit-path option:

	rubydictionary \
			--dict-name=Sinatra \
			--dict-id=com.sinatrarb.Dictionary \
			--kit-path=~/Source/DictionaryDevKit

Authors

See the Github contributors page.

Links