search

evan / echoe

A Rubygems packaging tool that provides Rake tasks for documentation, extension compiling, testing, and deployment
http://fauna.github.com/fauna/echoe
Academic Free License v3.0
82 stars 17 forks source link

Echoe passes readme.md files to rdoc, leading to extraneous warning #9

Closed arsduo closed 13 years ago

arsduo commented 13 years ago

First, great gem -- we've been using echoe for our project (Koala) and really like it.

I noticed that in setting up rdoc options, echoe looks for readme files in a way that catches "readme.md". Since rdoc doesn't natively know how to parse markdown, you then get "Could not find main page readme.md" warnings when installing the gem. It's fairly minor, but it looks kinda bad when a user is installing the gem and gets warnings.

I hacked my local copy to ignore .md files, but I don't know if that's a sustainable solution (textile probably has similar issues); perhaps a "no readme" flag or an option to ignore certain files for readme would work, though neither seem very elegant.

Thanks again!

evan commented 13 years ago

You can set the rdoc_pattern in your Rakefile to deal with this kind of issue on a per-project basis.

Thanks!