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


 

Forums >

comp.lang.ruby

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

Victor Reyes

5/14/2008 11:08:00 AM

[Note: parts of this message were removed to make it a legal post.]

Team,

Is the information found on *http://www.ruby-doc...* up to date? If
so, is there a way to download it so it could be used off-line?

Thank you

Victor
7 Answers

Jano Svitok

5/14/2008 11:31:00 AM

0

On Wed, May 14, 2008 at 1:07 PM, Victor Reyes <victor.reyes@gmail.com> wrote:
> Team,
>
> Is the information found on *http://www.ruby-doc...* 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.

Victor Reyes

5/14/2008 12:29:00 PM

0

[Note: parts of this message were removed to make it a legal post.]

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 *http://www.ruby-doc...* 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.
>
>

Jesús Gabriel y Galán

5/14/2008 1:05:00 PM

0

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

Phillip Gawlowski

5/14/2008 1:24:00 PM

0

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

Jesús Gabriel y Galán 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?. 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 Gawlowski
Twitter: twitter.com/cynicalryan
Blog: http://justarubyist.bl...

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

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

Phillip Gawlowski

5/14/2008 1:31:00 PM

0

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

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. ;)
|
| 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.bl...

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

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

matt

5/14/2008 2:06:00 PM

0

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

http://www.ruby-lang.org/en/...

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.


--
matt neuburg, phd = matt@tidbits.com, http://www.tidbits...
Leopard - http://www.takecontrolbooks.com/leopard-custom...
AppleScript - http://www.amazon.com/gp/product/...
Read TidBITS! It's free and smart. http://www.t...

Jesús Gabriel y Galán

5/14/2008 2:28:00 PM

0

On Wed, May 14, 2008 at 4:10 PM, matt neuburg <matt@tidbits.com> wrote:
> Jes=FAs Gabriel y Gal=E1n <jgabrielygalan@gmail.com> wrote:
>
> > On Wed, May 14, 2008 at 1:30 PM, Jano Svitok <jan.svitok@gmail.com> wr=
ote:
> > >
> > > It's easy:
> > >
> > > - go to your ruby source dir, (c:\ruby\src\ruby-X.X.X-pX for Window=
s),
> >
> > 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
>
> http://www.ruby-lang.org/en/...
>
> 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.