dentafrice/doc_to_dash — pull request #2 by royw (2012-11-08 08:06:09+00:00)
Title: added plist support for either frames.html (yard) or index.html (rdoc)

Caleb,

Thank you for doc_to_dash, I'm loving it!

Here's a further tweak to better support yard docs.

Basically the yard generated frames.html looks better as the docset index page than the index.html (which depends on javascript navigation) but rdoc does not generate a frames.html. Also added an option, :index_file, to allow the user to explicitly set which file to use. So the logic is:

use options[:index_file] if it exists
else use frames.html if it exists
else use index.html if it exists
else do not specify a dashIndexFilePath key in the info.plist.

The change is isolated in lib/doc_to_dash.rb if that is all you want to use.

The rest of the changes are dev support. An rspec to support this change, and rake tasks to:

* run rspec,
* generate rdoc & yard documentation,
* generate docset (from either rdoc or yard),
* version bumping.

These rake tasks are from my rakelib project (https://github.com/royw/rakelib).

HTH,
Roy