# Ruby (Rdoc) documentation http://www.ruby-doc.org/core/

**URL:** <https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588>\
**Category:** Ruby\
**Created:** [May 14, 2008, 1:08pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588 "2008-05-14T13:08:56Z")\
**Posts on this page:** 8\
**Page:** 1

<div class="post-metadata">

**Author:** ![ribes](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/f4b2a3/32.png) [@ribes](https://www.ruby-forum.com/u/ribes)\
**Post date:** [May 14, 2008, 1:08pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588/1 "2008-05-14T13:08:56Z")

</div>

Team,

Is the information found on _[RDoc Documentation](http://www.ruby-doc.org/core/)_ up to date?  
If  
so, is there a way to download it so it could be used off-line?

Thank you

Victor

---

<div class="post-metadata">

**Author:** ![ribes](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/f4b2a3/32.png) [@ribes](https://www.ruby-forum.com/u/ribes)\
**Post date:** [May 14, 2008, 1:32pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588/2 "2008-05-14T13:32:18Z")

</div>

On Wed, May 14, 2008 at 1:07 PM, Victor R. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
wrote:

> Team,
> 
> Is the information found on _[RDoc Documentation](http://www.ruby-doc.org/core/)_ up to date? If  
> so, is there a way to download it so it could be used off-line?
> 
> Thank you
> 
> Victor

It’s easy:

- go to your ruby source dir, (c:\ruby\src\ruby-X.X.X-pX for Windows),
- run rdoc -o ,
- …
- PROFIT! (more precisely, you have a copy of ruby-doc/core in   
for your exact version of ruby)

is any dir where you want to place the generated docs. You have  
to specify one, because  
default for rdoc (‘doc’) clashes with ruby’s doc dir.

You may want to ‘gem install rdoc’ before this, eric recently reworked  
rdoc.

J.

---

<div class="post-metadata">

**Author:** ![ribes](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/f4b2a3/32.png) [@ribes](https://www.ruby-forum.com/u/ribes)\
**Post date:** [May 14, 2008, 2:30pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588/3 "2008-05-14T14:30:11Z")

</div>

Thank you!

Victor

---

<div class="post-metadata">

**Author:** ![ribes](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/f4b2a3/32.png) [@ribes](https://www.ruby-forum.com/u/ribes)\
**Post date:** [May 14, 2008, 3:06pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588/4 "2008-05-14T15:06:37Z")

</div>

On Wed, May 14, 2008 at 1:30 PM, Jano S. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
wrote:

> It’s easy:
> 
> - go to your ruby source dir, (c:\ruby\src\ruby-X.X.X-pX for Windows),

Anybody know where this is in Ubuntu?. I’m being very dense this week,  
but I can’t find it. Maybe I’m missing a package with the sources, but  
I can’t find that either.

Thanks,

Jesus.

---

<div class="post-metadata">

**Author:** ![ribes](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/f4b2a3/32.png) [@ribes](https://www.ruby-forum.com/u/ribes)\
**Post date:** [May 14, 2008, 3:31pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588/5 "2008-05-14T15:31:23Z")

</div>

-----BEGIN PGP SIGNED MESSAGE-----  
Hash: SHA1

Phillip G. wrote:  
|  
| You’ll probably need the ruby1.8-dev package (or something similar).

Actually, you’ll need something called ruby-src from Ubuntu compatible  
repositories that provide .deb packaged source files, since the headers  
alone probably won’t create what you need.

| Canonically, sources are palced in /usr/src/package\_name, but I don’t  
| know if Canonical is canonical in that regard. 😉  
|  
| Though, ‘locate ruby.h’, or ‘find ruby.h’ should ferret the source  
| location out for you, too (might want to use these first, before you  
| hunt for a package you don’t need).  
|

The easiest way to get the sources is probably downloading them from  
[ruby-lang.org](http://ruby-lang.org), extracting them, and let RDoc loose on the source code,  
with the -o option. (No messing around with apt-get’s repository  
configuration, for example, and you know where you extracted the  
sources, too. :P)

* * *

Phillip G.  
Twitter: [twitter.com/cynicalryan](http://twitter.com/cynicalryan)  
Blog: [http://justarubyist.blogspot.com](http://justarubyist.blogspot.com)

~ The purpose of writing is to inflate weak ideas, obscure pure  
reasoning, and  
inhibit clarity. With a little practice, writing can be an intimidating  
and  
impenetrable fog! – Calvin  
-----BEGIN PGP SIGNATURE-----  
Version: GnuPG v1.4.8 (MingW32)  
Comment: Using GnuPG with Mozilla - [http://enigmail.mozdev.org](http://enigmail.mozdev.org)

iEYEARECAAYFAkgq6YQACgkQbtAgaoJTgL/lvQCggztuKREPE6P/hSgw8Imdkd7s  
IAwAmgKMIU7C9CppG+M7OClI34u0TcHb  
=jhum  
-----END PGP SIGNATURE-----

---

<div class="post-metadata">

**Author:** ![ribes](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/f4b2a3/32.png) [@ribes](https://www.ruby-forum.com/u/ribes)\
**Post date:** [May 14, 2008, 4:11pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588/6 "2008-05-14T16:11:41Z")

</div>

Jesús Gabriel y Galán [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> On Wed, May 14, 2008 at 1:30 PM, Jano S. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:
> 
> > It’s easy:
> > 
> > - go to your ruby source dir, (c:\ruby\src\ruby-X.X.X-pX for Windows),
> 
> Anybody know where this is in Ubuntu?

It might not be anywhere. (It isn’t anywhere on my Mac OS X machine.)  
Just download the source code from

[Download Ruby](http://www.ruby-lang.org/en/downloads/)

Unzip / untar it, cd into it, and run rdoc against it. Be patient, as  
rdoc parses all sources before writing anything, and then during the  
last phase (HTML generation) provides no feedback. Good time to get a  
cup of coffee. Mmmmm… coffee… m.

---

<div class="post-metadata">

**Author:** ![ribes](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/f4b2a3/32.png) [@ribes](https://www.ruby-forum.com/u/ribes)\
**Post date:** [May 14, 2008, 4:29pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588/7 "2008-05-14T16:29:07Z")

</div>

On Wed, May 14, 2008 at 4:10 PM, matt neuburg [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> It might not be anywhere. (It isn’t anywhere on my Mac OS X machine.)  
> Just download the source code from
> 
> [Download Ruby](http://www.ruby-lang.org/en/downloads/)
> 
> Unzip / untar it, cd into it, and run rdoc against it. Be patient, as  
> rdoc parses all sources before writing anything, and then during the  
> last phase (HTML generation) provides no feedback. Good time to get a  
> cup of coffee. Mmmmm… coffee… m.

Thanks Philip and Matt. I’ll do that just downloading the sources  
myself.

Jesus.

---

<div class="post-metadata">

**Author:** ![ribes](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/f4b2a3/32.png) [@ribes](https://www.ruby-forum.com/u/ribes)\
**Post date:** [May 14, 2008, 3:25pm UTC](https://www.ruby-forum.com/t/ruby-rdoc-documentation-http-www-ruby-doc-org-core/137588/8 "2008-05-14T15:25:28Z")

</div>

-----BEGIN PGP SIGNED MESSAGE-----  
Hash: SHA1

Jesús Gabriel y Galán wrote:  
| On Wed, May 14, 2008 at 1:30 PM, Jano S. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:  
|\> It’s easy:  
|\>  
|\> - go to your ruby source dir, (c:\ruby\src\ruby-X.X.X-pX for Windows),  
|  
| Anybody know where this is in Ubuntu?. I’m being very dense this week,  
| but I can’t find it. Maybe I’m missing a package with the sources, but  
| I can’t find that either.

You’ll probably need the ruby1.8-dev package (or something similar).

Canonically, sources are palced in /usr/src/package\_name, but I don’t  
know if Canonical is canonical in that regard. 😉

Though, ‘locate ruby.h’, or ‘find ruby.h’ should ferret the source  
location out for you, too (might want to use these first, before you  
hunt for a package you don’t need).

(N.B.: Canonical = Mark Shuttleworth’s corporation running the Ubuntu  
business)

* * *

Phillip G.  
Twitter: [twitter.com/cynicalryan](http://twitter.com/cynicalryan)  
Blog: [http://justarubyist.blogspot.com](http://justarubyist.blogspot.com)

Why stop now? Just when I’m hating it.  
~ – Marvin  
-----BEGIN PGP SIGNATURE-----  
Version: GnuPG v1.4.8 (MingW32)  
Comment: Using GnuPG with Mozilla - [http://enigmail.mozdev.org](http://enigmail.mozdev.org)

iEYEARECAAYFAkgq5/UACgkQbtAgaoJTgL8yxwCfd+hg+RrEq5qt1N/JiKYR2mgc  
T3gAn1T3/e70yvxqPrqNs3ePqPteaBaK  
=Dt+o  
-----END PGP SIGNATURE-----
