Offline Rails Framework Documentation

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.rubyonrails.org/
using ‘File / Save As…’, but the frames get all confused.

Any help greatly appreciated.

  • Paul D.

On 5/29/07, Paul [email protected] 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.rubyonrails.org/
using ‘File / Save As…’, but the frames get all confused.

Any help greatly appreciated.

  • Paul D.
  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.

  1. 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 :wink:

Jano

Jano S. wrote:

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

www.ruby-doc.org

On 5/29/07, Paul [email protected] 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.rubyonrails.org/
using ‘File / Save As…’, but the frames get all confused.

Any help greatly appreciated.

  • Paul D.

$gem_server

Then open your browser @ http://localhost:8808/

Enjoy!

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.

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 [email protected] wrote:

I tried doing ‘File / Save As…’ but that didn’t work.
Please do not encourage people to do this.
www.ruby-doc.org


http://www.jeremymcanally.com/

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

My blogs:
http://www.mrneighborly.com/
http://www.rubyinpractice.com/

What am I doing wrong? Perhaps because when I installed rails I didn’t
pass
the -y flag?

Thanks in advance:

rake doc:rails --trace
(in /home/someonespecial/packages/aptana/workspace/cookbook)
** Invoke doc:rails (first_time)
** Invoke doc/api/index.html (first_time)
** Invoke README (first_time, not_needed)
rake aborted!
Don’t know how to build task ‘vendor/rails/railties/CHANGELOG’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1472:in []' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:369:ininvoke_prerequisites’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1003:in each' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1003:insend’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1003:in each' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:368:ininvoke_prerequisites’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:361:in invoke' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:355:insynchronize’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:355:in invoke' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:369:ininvoke_prerequisites’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1003:in each' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1003:insend’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1003:in each' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:368:ininvoke_prerequisites’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:361:in invoke' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:355:insynchronize’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:355:in invoke' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1739:intop_level’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1739:in each' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1739:intop_level’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1761:in
standard_exception_handling' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1733:intop_level’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1711:in run' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1761:instandard_exception_handling’
/usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/lib/rake.rb:1708:in run' /usr/local/lib/ruby/gems/1.8/gems/rake-0.7.3/bin/rake:7 /usr/local/bin/rake:16:inload’
/usr/local/bin/rake:16

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

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

On 6/2/07, list. rb [email protected] wrote:

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/000501.html

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

Jano

I guess it’s wget for the win?

This forum is not affiliated to the Ruby language, Ruby on Rails framework, nor any Ruby applications discussed here.

| Privacy Policy | Terms of Service | Remote Ruby Jobs