Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Next generation rdoc.info site
Ruby JavaScript
Branch: master
Pull request Compare This branch is 244 commits behind lsegal:master.

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib
public
scripts
spec
templates
.gitignore
Capfile
README.md
Rakefile
app.rb
config.ru
config.yaml.sample
featured.yaml.sample
init.rb

README.md

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 && cd rubydoc.info
  • rake gems:update (to retrieve the latest list of published gems)
  • git clone git://github.com/lsegal/yard yard
  • 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
Something went wrong with that request. Please try again.