RubyDoc.info: YARD Doc Server

RubyDoc.info is the next generation Ruby doc server, replacing http://rdoc.info and http://yardoc.org/docs. This doc server uses YARD to generate project documentation on the fly, for both published RubyGems as well as GitHub projects.

The public doc server is hosted at http://rubydoc.info

Getting Started

This site is a public service and is community-supported. Patches and enhancements are welcome.

Running the doc server locally is easy:

  • git clone git://github.com/lsegal/rubydoc.info
  • git clone git://github.com/lsegal/yard yard (must be one level above the Gemfile)
  • cd rubydoc.info
  • bundle install
  • rake gems:update
  • rackup config.ru

Contributors

RubyDoc.info was created by Loren Segal (YARD) and Nick Plante (rdoc.info). Additional help was provided by:

  • Jeff Rafter (rdoc.info)
  • Brian Turnbull (rdoc.info)
  • Lee Jarvis
  • Sebastian Staudt
  • Nicos Gollan