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 CSS

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
lib
test
.autotest
.document
.gitignore
History.txt
LICENSE.txt
Manifest.txt
README.txt
RI.txt
Rakefile

README.txt

= \RDoc - Ruby Documentation System

* {RDoc Project Page}[https://github.com/rdoc/rdoc/]
* {RDoc Documentation}[http://rdoc.rubyforge.org/]
* {RDoc Bug Tracker}[https://github.com/rdoc/rdoc/issues]

== DESCRIPTION:

RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
includes the +rdoc+ and +ri+ tools for generating and displaying online
documentation.

See RDoc for a description of RDoc's markup and basic use.

== SYNOPSIS:

To generate HTML documentation:

  rdoc .

To generate documentation programmatically:

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

== BUGS:

If you find a bug, please report it at the RDoc project's
tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge

== LICENSE:

RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
Portions (c) 2007-2010 Eric Hodel.  Portions copyright others, see individual
files for details.

It is free software, and may be redistributed under the terms specified in
LICENSE.txt.

== WARRANTY:

This software is provided "as is" and without any express or implied
warranties, including, without limitation, the implied warranties of
merchantibility and fitness for a particular purpose.
Something went wrong with that request. Please try again.