From: Jano Svitok <jan.svitok@...>
Date: 2007-05-10T01:36:32+09:00
Subject: Re: How to generate HTML API doucment for ruby?

On 5/9/07, Alan <laji.inbox@gmail.com> wrote:
> I googled the internet and didn't find any clear instructions I can
> follow.
>
> Now the v1.8.6 is out and the place I go for ruby document at
> http://www.ruby-doc.org/core/ does not have the updated API for v1.8.6.
> I wonder if I can generate the similar document locally with my ruby
> installation. Can someone give me a clear instruction on how to generate
> it? For example, if my ruby is installed at c:\ruby (Windows platform),
> what would be the command to generate the HTML API doc for the core
> classes?
>
> Thanks,

1. the docs on the page you mentioned should be 1.8.6 (although the
main page still says 1.8.5)

2. you can generate them easily: go to c:\ruby\src\ruby-x.x.x\ and run
rdoc -o rdoc
(to prevent compliants about 'doc' dir already existing)

run rdoc -h for more tweaking possibilities. It's even possible that
the docs are already generated somewhere...

Jano