rdoc files: how to read them?

  • Follow


I saw a book on The Pragmatic Boookshelf that I thought I might wand to buy=
, but I saw no way to see a sample of its content a la Amazon.

I downloaded its code and saw some .rdoc files.  I could view them as text,=
  but that's obviously not the best approach.  I saw a recommendation somew=
here to view them in a browser.  I dragged the filename into the browser, w=
hich produced a somewhat better result.

I believe that the content of http://www.ruby-doc.org/stdlib-1.9.2// is bas=
ed on generated rdoc's and look great in my browser. What do I have to do t=
o get the same formatting in my browser for the rdoc's I downloaded?

I'm running Firefox 10.0.2 over WinXP-Pro/SP3.

Thanks in Advance,
Richard


0
Reply RichardDummyMailbox58407 (349) 3/15/2012 4:45:25 PM

Am 15.03.2012 17:45, schrieb RichardOnRails:
> I saw a book on The Pragmatic Boookshelf that I thought I might wand
> to buy, but I saw no way to see a sample of its content a la Amazon.
> 
> I downloaded its code and saw some .rdoc files.  I could view them as
> text,  but that's obviously not the best approach.  I saw a
> recommendation somewhere to view them in a browser.  I dragged the
> filename into the browser, which produced a somewhat better result.
> 
> I believe that the content of http://www.ruby-doc.org/stdlib-1.9.2//
> is based on generated rdoc's and look great in my browser. What do I
> have to do to get the same formatting in my browser for the rdoc's I
> downloaded?

I don’t know the exact RDoc template they use at ruby-doc.org (I wish I
did, it’s great), but you can transform RDoc files into HTML just the
same way you transform Ruby documentation into HTML.

$ rdoc file1.rdoc file2.rdoc file3.rdoc ...

Note that under Ruby < 1.9 you have to install the `rdoc' gem first.

Vale,
Marvin

0
Reply sutniuq (131) 3/15/2012 10:13:12 PM


On Thursday, March 15, 2012 6:13:12 PM UTC-4, Marvin G=FClker wrote:
> Am 15.03.2012 17:45, schrieb RichardOnRails:
> > I saw a book on The Pragmatic Boookshelf that I thought I might wand
> > to buy, but I saw no way to see a sample of its content a la Amazon.
> >=20
> > I downloaded its code and saw some .rdoc files.  I could view them as
> > text,  but that's obviously not the best approach.  I saw a
> > recommendation somewhere to view them in a browser.  I dragged the
> > filename into the browser, which produced a somewhat better result.
> >=20
> > I believe that the content of http://www.ruby-doc.org/stdlib-1.9.2//
> > is based on generated rdoc's and look great in my browser. What do I
> > have to do to get the same formatting in my browser for the rdoc's I
> > downloaded?
>=20
> I don=92t know the exact RDoc template they use at ruby-doc.org (I wish I
> did, it=92s great), but you can transform RDoc files into HTML just the
> same way you transform Ruby documentation into HTML.

Hi Marvin,

Thanks for your response.
>=20
> $ rdoc file1.rdoc file2.rdoc file3.rdoc ...
>=20
> Note that under Ruby < 1.9 you have to install the `rdoc' gem first.
>=20
> Vale,
> Marvin



On Thursday, March 15, 2012 6:13:12 PM UTC-4, Marvin G=FClker wrote:
> Am 15.03.2012 17:45, schrieb RichardOnRails:
> > I saw a book on The Pragmatic Boookshelf that I thought I might wand
> > to buy, but I saw no way to see a sample of its content a la Amazon.
> >=20
> > I downloaded its code and saw some .rdoc files.  I could view them as
> > text,  but that's obviously not the best approach.  I saw a
> > recommendation somewhere to view them in a browser.  I dragged the
> > filename into the browser, which produced a somewhat better result.
> >=20
> > I believe that the content of http://www.ruby-doc.org/stdlib-1.9.2//
> > is based on generated rdoc's and look great in my browser. What do I
> > have to do to get the same formatting in my browser for the rdoc's I
> > downloaded?
>=20
> I don=92t know the exact RDoc template they use at ruby-doc.org (I wish I
> did, it=92s great), but you can transform RDoc files into HTML just the
> same way you transform Ruby documentation into HTML.
>=20
> $ rdoc file1.rdoc file2.rdoc file3.rdoc ...
>=20
> Note that under Ruby < 1.9 you have to install the `rdoc' gem first.
>=20
> Vale,
> Marvin

I got it working. I wrote up what I did and pasted an image of the Command =
Window when I was done.  At the bottom you'll see the name of the html file=
 that was created, which creates a graphical report in the browser.

There's enough there to reconstruct what I did and get the generated code.

Thanks for your interest in my problem. All's well now.

Best wishes,
Richard
0
Reply RichardDummyMailbox58407 (349) 3/16/2012 3:08:48 AM

2 Replies
78 Views

(page loaded in 0.19 seconds)

Similiar Articles:













7/22/2012 6:48:38 AM


Reply: