Asp Forum - Offline Rails Framework Documentation

Paul

5/29/2007 9:49:00 PM

I would like to download the Rails Framework Documentation (http://
rails.rubyonrails.com/) so I can use it offline.
I tried doing 'File / Save As...' but that didn't work.

I had limited success with downloading http://corelib.rubyon...
using 'File / Save As...', but the frames get all confused.

Any help greatly appreciated.
- Paul Davidowitz

7 Answers

Jano Svitok

5/29/2007 10:10:00 PM

On 5/29/07, Paul <pdavidow@gmail.com> wrote:
> I would like to download the Rails Framework Documentation (http://
> rails.rubyonrails.com/) so I can use it offline.
> I tried doing 'File / Save As...' but that didn't work.
>
> I had limited success with downloading http://corelib.rubyon...
> using 'File / Save As...', but the frames get all confused.
>
> Any help greatly appreciated.
> - Paul Davidowitz

1. download wget, and run wget -m -k api.rubionrails.com (I'm not
about the switches, use --help and or google to find out)

2. you can obtain docs for a particular gem if you run rdoc in the
respective directory. Or, run rdoc with a list of paths to all the
rails gems. i.e.

rdoc c:/ruby/lib/1.8/gems/activerecord-1.x.x/lib c:/ruby/lib/... etc.

3. there was a recent thread about generating rdoc for the ruby core,
as seen on ruby-doc.org ;-). The rails docs are generated similarly.

DISCLAIMER: It's midnight here, so take this as a hint, and please
work out the details ;-)

Jano

Emilio Tagua

5/29/2007 11:02:00 PM

James Britt

5/29/2007 11:42:00 PM

Jano Svitok wrote:
> On 5/29/07, Paul <pdavidow@gmail.com> wrote:
>> I would like to download the Rails Framework Documentation (http://
>> rails.rubyonrails.com/) so I can use it offline.
>> I tried doing 'File / Save As...' but that didn't work.
>>
>> I had limited success with downloading http://corelib.rubyon...
>> using 'File / Save As...', but the frames get all confused.
>>
>> Any help greatly appreciated.
>> - Paul Davidowitz
>
> 1. download wget, and run wget -m -k api.rubionrails.com (I'm not
> about the switches, use --help and or google to find out)

Please do not encourage people to do this.

It will eat up considerable bandwidth from a site that is offering a
free service, and gains you nothing you cannot get for yourself in
other, better ways.

--
James Britt

www.ruby-doc.org

Jeremy McAnally

5/31/2007 1:21:00 AM

Create a Rails app, and then from the root of the application execute:
rake doc:rails

That will place the API documentation in doc/api/.

--Jeremy

On 5/30/07, list. rb <list.rb@gmail.com> wrote:
> Can you share with the list what those better ways are? Is it tar'd up
> somewhere? I've always wanted to get a local copy of the api and never
> thought about using wget until this mail.
>
> On 5/29/07, James Britt <james.britt@gmail.com> wrote:
> >
> > Jano Svitok wrote:
> > > On 5/29/07, Paul <pdavidow@gmail.com> wrote:
> > >> I would like to download the Rails Framework Documentation (http://
> > >> rails.rubyonrails.com/) so I can use it offline.
> > >> I tried doing 'File / Save As...' but that didn't work.
> > >>
> > >> I had limited success with downloading http://corelib.rubyon...
> > >> using 'File / Save As...', but the frames get all confused.
> > >>
> > >> Any help greatly appreciated.
> > >> - Paul Davidowitz
> > >
> > > 1. download wget, and run wget -m -k api.rubionrails.com (I'm not
> > > about the switches, use --help and or google to find out)
> >
> > Please do not encourage people to do this.
> >
> > It will eat up considerable bandwidth from a site that is offering a
> > free service, and gains you nothing you cannot get for yourself in
> > other, better ways.
> >
> >
> >
> > --
> > James Britt
> >
> > www.ruby-doc.org
> >
> >
>

--
http://www.jeremymca...

My free Ruby e-book:
http://www.humblelittlerubybook...

My blogs:
http://www.mrneigh...
http://www.rubyinpra...

James Britt

5/31/2007 1:35:00 AM

list. rb wrote:
> Can you share with the list what those better ways are? Is it tar'd up
> somewhere? I've always wanted to get a local copy of the api and never
> thought about using wget until this mail.
>

Get the source (i.e gem install rails -y)
Run rdoc over the source

I'm pretty sure that's how it gets created for display on rubyonrails.com

If there's more to than that, then perhaps someone on the rails list
could give more detail.

James

Daniel Lucraft

5/31/2007 7:26:00 AM

List Rb wrote:
> What am I doing wrong? Perhaps because when I installed rails I didn't
> pass
> the -y flag?
>
> Thanks in advance:

That's exactly what I get. On the other hand, doesn't using the
installed gems for docs mean that they will be split up into rails,
activerecord etc...?

best,
Dan

--
Posted via http://www.ruby-....

Jano Svitok

6/2/2007 8:58:00 AM

On 6/2/07, list. rb <list.rb@gmail.com> wrote:
> I guess it's wget for the win?
>
> On 5/31/07, Daniel Lucraft <dan@fluentradical.com> wrote:
> >
> > List Rb wrote:
> > > What am I doing wrong? Perhaps because when I installed rails I didn't
> > > pass
> > > the -y flag?
> > >
> > > Thanks in advance:
> >
> > That's exactly what I get. On the other hand, doesn't using the
> > installed gems for docs mean that they will be split up into rails,
> > activerecord etc...?
> >
> > best,
> > Dan

Ok, so some more things to try:

1. [1] says do
rake rails:freeze:gems
before
rake doc:rails

2. if you don't want to freeze your rails app, create a new one and freeze that.

3. this is a Rails specific question now, so it'd better to ask on
rails list/group - this is not a question of rdoc anymore, it's about
how their rakefiles are set up.

[1] http://squizlog.keithpitty.org/archives/0...

(I didn't try this, I just googled, so I might be wrong.)

Jano

comp.lang.ruby

Offline Rails Framework Documentation

Paul

Jano Svitok

Emilio Tagua

James Britt

Jeremy McAnally

James Britt

Daniel Lucraft

Jano Svitok

x Login to ForumsZone