klaasprause.com

Ruby RDoc ressources

I quite often search for infos about RDoc, so here are some useful links.

How to write RDoc comments

• RDoc Homepage The homepage links
• Ruby Standard Lib documentation links from the standard library documentation
• rdoc.info allows you to generate RDoc on the fly for Github projects and browse it as well

How to browse RDoc for installed gems

• bdoc very nice browsing for documentation should be used with the better hanna rdoc template
• sinatra-rubygems reimplementation of gem server to use apache not webrick
• Gembox sinatra based application to browse the locally installed gems
• docs.github.com for github based projects that use rdoc.info