\
**Category:** Ruby\
**Created:** [May 9, 2007, 5:50pm UTC](https://www.ruby-forum.com/t/how-to-generate-html-api-doucment-for-ruby/103720 "2007-05-09T17:50:23Z")\
**Posts on this page:** 5\
**Page:** 1
**Author:**  [@alan](https://www.ruby-forum.com/u/alan)\
**Post date:** [May 9, 2007, 5:50pm UTC](https://www.ruby-forum.com/t/how-to-generate-html-api-doucment-for-ruby/103720/1 "2007-05-09T17:50:23Z")
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/](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,
---
**Author:**  [@alan](https://www.ruby-forum.com/u/alan)\
**Post date:** [May 9, 2007, 6:37pm UTC](https://www.ruby-forum.com/t/how-to-generate-html-api-doucment-for-ruby/103720/2 "2007-05-09T18:37:58Z")
On 5/9/07, Alan [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:
> 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
---
**Author:**  [@alan](https://www.ruby-forum.com/u/alan)\
**Post date:** [May 9, 2007, 7:02pm UTC](https://www.ruby-forum.com/t/how-to-generate-html-api-doucment-for-ruby/103720/3 "2007-05-09T19:02:01Z")
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
> [RDoc Documentation](http://www.ruby-doc.org/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 B.
“Blanket statements are over-rated”
---
**Author:**  [@alan](https://www.ruby-forum.com/u/alan)\
**Post date:** [May 9, 2007, 8:05pm UTC](https://www.ruby-forum.com/t/how-to-generate-html-api-doucment-for-ruby/103720/4 "2007-05-09T20:05:09Z")
You do but the Rubydoc front page ([http://www.ruby-doc.org/](http://www.ruby-doc.org/)) says
1.8.5 is the current release.
–Jeremy
On 5/9/07, James B. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:
> core API docs.
>
> –
> James B.
>
> “Blanket statements are over-rated”
–
[http://www.jeremymcanally.com/](http://www.jeremymcanally.com/)
My free Ruby e-book:
[http://www.humblelittlerubybook.com/book/](http://www.humblelittlerubybook.com/book/)
My blogs:
> **[Site not found · DreamHost](http://www.mrneighborly.com/)**
>
> The owner of this domain has not yet uploaded their website.
[http://www.rubyinpractice.com/](http://www.rubyinpractice.com/)
---
**Author:**  [@alan](https://www.ruby-forum.com/u/alan)\
**Post date:** [May 10, 2007, 1:37am UTC](https://www.ruby-forum.com/t/how-to-generate-html-api-doucment-for-ruby/103720/5 "2007-05-10T01:37:39Z")
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?