[lnkForumImage]
TotalShareware - Download Free Software
Confronta i prezzi di migliaia di prodotti.
Asp Forum
 Home | Login | Register | Search 


 

Forums >

comp.lang.ruby

How to generate HTML API doucment for ruby?

Alan

5/9/2007 3:50:00 PM

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... 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,

--
Posted via http://www.ruby-....
4 Answers

Jano Svitok

5/9/2007 4:37:00 PM

0

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... 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

James Britt

5/9/2007 5:01:00 PM

0

Alan 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... does not have the updated API for v1.8.6.

Why do you say that?

As best I can tell, I have the 1.8.6 source docs served as the default
core API docs.


--
James Britt

"Blanket statements are over-rated"

Jeremy McAnally

5/9/2007 6:04:00 PM

0

You do but the Rubydoc front page (http://www.rub...) says
1.8.5 is the current release.

--Jeremy

On 5/9/07, James Britt <james.britt@gmail.com> wrote:
> Alan 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.rub...core/ does not have the updated API for v1.8.6.
>
> Why do you say that?
>
> As best I can tell, I have the 1.8.6 source docs served as the default
> core API docs.
>
>
> --
> James Britt
>
> "Blanket statements are over-rated"
>
>


--
http://www.jeremymca...

My free Ruby e-book:
http://www.humblelittlerubybook...

My blogs:
http://www.mrneigh...
http://www.rubyinpra...

Alan

5/9/2007 11:38:00 PM

0

Thanks for the help, I've successfully generated the html doc locally
with the rDoc tool.

As pointed out, I thought the doc at ruby-doc is still 1.8.5 because its
front page didn't mention anything about 1.8.6. I am not sure how to
verify its version, as the included changelog file with my windows
installation didn't say much about the core API changes from 1.8.5 ->
1.8.6. If there is a page that details this core API change that someone
know, could you please post it here?

--
Posted via http://www.ruby-....