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

Team,

Is the information found on *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 <dest>,
- ...
- PROFIT! (more precisely, you have a copy of ruby-doc/core in <dest>
for your exact version of ruby)

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

···

On Wed, May 14, 2008 at 1:07 PM, Victor Reyes <victor.reyes@gmail.com> wrote:

Team,

Is the information found on *RDoc Documentation* up to date? If
so, is there a way to download it so it could be used off-line?

Thank you

Victor

Thank you!

Victor

···

On Wed, May 14, 2008 at 7:30 AM, Jano Svitok <jan.svitok@gmail.com> wrote:

On Wed, May 14, 2008 at 1:07 PM, Victor Reyes <victor.reyes@gmail.com> > wrote:
> Team,
>
> Is the information found on *RDoc Documentation* 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 <dest>,
- ...
- PROFIT! (more precisely, you have a copy of ruby-doc/core in <dest>
for your exact version of ruby)

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

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.

···

On Wed, May 14, 2008 at 1:30 PM, Jano Svitok <jan.svitok@gmail.com> wrote:

It's easy:

- go to your ruby source dir, (c:\ruby\src\ruby-X.X.X-pX for Windows),

Jesús Gabriel y Galán 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. :wink:

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 Gawlowski
Twitter: twitter.com/cynicalryan
Blog: http://justarubyist.blogspot.com

Why stop now? Just when I'm hating it.
~ -- Marvin

···

On Wed, May 14, 2008 at 1:30 PM, Jano Svitok <jan.svitok@gmail.com> wrote:

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

Download Ruby

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.

···

Jesús Gabriel y Galán <jgabrielygalan@gmail.com> wrote:

On Wed, May 14, 2008 at 1:30 PM, Jano Svitok <jan.svitok@gmail.com> 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?

--
matt neuburg, phd = matt@tidbits.com, Matt Neuburg’s Home Page
Leopard - http://www.takecontrolbooks.com/leopard-customizing.html
AppleScript - http://www.amazon.com/gp/product/0596102119
Read TidBITS! It's free and smart. http://www.tidbits.com

Phillip Gawlowski 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. :wink:

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, 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 Gawlowski
Twitter: twitter.com/cynicalryan
Blog: 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

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

Jesus.

···

On Wed, May 14, 2008 at 4:10 PM, matt neuburg <matt@tidbits.com> wrote:

Jesús Gabriel y Galán <jgabrielygalan@gmail.com> wrote:

> On Wed, May 14, 2008 at 1:30 PM, Jano Svitok <jan.svitok@gmail.com> 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

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.