I know the immediate reaction this is likely to get --half of which is probably just b/c it is coming from me. But putting these gut- reactions aside, consider it objectively. It makes sense...
RubyGems should not be generating rdocs. As good an example as any for when convention ought to triumph over configuration, this is it. As it stands we currently must fill out gemspec options: has_rdoc, rdoc_options and extra_rdoc_files, to get rdocs generated on install, but that's still not enough to get them right. For starters, --main README's are missing across the board. Well beyond that it prevents us from all forms of customization of our docs, from simply using a different template to using a system other then rdoc altogether. The current design completely constrains our documentation freedom. A far better solution is simply to designate a conventional location for html api docs, say doc/html-api/ or something like that, and just have gem server look for them there. For those who would rather generate docs then redistribute them (to save package size?) then provide a ruby script that does it, and the gemspec can have a field to designate that, which it can then run on install. That's much simpler solution and much more powerful to boot. T. _______________________________________________ Rubygems-developers mailing list [email protected] http://rubyforge.org/mailman/listinfo/rubygems-developers
