Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
RDoc produces HTML and online documentation for Ruby projects. RDoc includes the rdoc and ri tools for generating and displaying online documentation.
Ruby JavaScript HTML

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
test
History.txt
Manifest.txt
README.txt
Rakefile

README.txt

= RDoc

* http://rubyforge.org/projects/rdoc/

== DESCRIPTION:

RDoc is an application that produces documentation for one or more Ruby source
files.  RDoc includes the `rdoc` and `ri` tools for generating and displaying
online documentation.

At this point in time, RDoc 2.x is a work in progress and may incur further
API changes beyond what has been made to the RDoc 1.0.1.  Command-line tools
are largely unaffected, but internal APIs may shift rapidly.

== SYNOPSIS:

  gem 'rdoc'
  require 'rdoc/rdoc'
  # ... see RDoc

== BUGS:

If you found a bug, please report it at the RDoc project's tracker on
RubyForge:

http://rubyforge.org/tracker/?group_id=627

== LICENSE:

RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers,
portions (c) 2007-2008 Eric Hodel.  It is free software, and may be
redistributed under the terms specified in the README file of the Ruby
distribution.

Something went wrong with that request. Please try again.