Offline documentation for ruby on rails

hi,
can any one tell how to generate Offline documentation for ruby on
rails on windows

Aashish K. wrote:

hi,
can any one tell how to generate Offline documentation for ruby on
rails on windows

Rake will do it for you – look at rake -T to see the appropriate tasks.
railsbrain.com and railsapi.com also offer downloadable versions of
their Rails docs.

Best,

Marnen Laibow-Koser
http://www.marnen.org
[email protected]

On Thu, Jul 30, 2009 at 8:21 AM, Aashish
Kiran[email protected] wrote:

can any one tell how to generate Offline documentation for ruby on
rails on windows

I don’t know about the “windows” part, but on my system it’s already
there. Running “gem server” and going to http://localhost:8808 in a
browser shows me the rdoc for all the installed gems, including Rails.

HTH!

Hassan S. ------------------------ [email protected]
twitter: @hassan

On Jul 30, 11:33 am, Hassan S. [email protected]
wrote:

On Thu, Jul 30, 2009 at 8:21 AM, Aashish

Kiran[email protected] wrote:

can any one tell how to generate Offline documentation for ruby on
rails on windows

I don’t know about the “windows” part, but on my system it’s already
there. Running “gem server” and going tohttp://localhost:8808in a
browser shows me the rdoc for all the installed gems, including Rails.

What I do is run rake doc:rails which creates the same docs as on
api.rubyonrails.org (ie all the frameworks on one page). Then I serve
that locally and point the rdoc widget at it (so that I get search).

Fred

Hassan S. wrote:
[…]

I don’t know about the “windows” part, but on my system it’s already
there. Running “gem server” and going to http://localhost:8808 in a
browser shows me the rdoc for all the installed gems, including Rails.

Really? On my system, Rails is one of the gems that does not show an
rdoc link when I do that.

Best,

Marnen Laibow-Koser
http://www.marnen.org
[email protected]

On Thu, Jul 30, 2009 at 11:28 AM, Marnen
Laibow-Koser[email protected] wrote:

there. Running “gem server” and going to http://localhost:8808 in a
browser shows me the rdoc for all the installed gems, including Rails.

Really? On my system, Rails is one of the gems that does not show an
rdoc link when I do that.

!suckimoto, you’re right – the rdoc link is inactive. Scratch that,
then :slight_smile:


Hassan S. ------------------------ [email protected]
twitter: @hassan

can any one tell how to generate Offline documentation for ruby on
rails on windows

If you just want a copy of it and don’t want to genereate it yourself…

http://www.railsbrain.com/

Be nice though and download a copy rather than use up their bandwidth…

Pretty nice interface to searching that works in offline mode as well…

-philip

Frederick C. wrote:

On Jul 30, 11:33�am, Hassan S. [email protected]
wrote:

What I do is run rake doc:rails which creates the same docs as on
api.rubyonrails.org (ie all the frameworks on one page). Then I serve
that locally and point the rdoc widget at it (so that I get search).

Fred

where to run rake doc:rails

On Jul 30, 3:01 pm, Hassan S. [email protected]
wrote:

That’s the slightly annoying thing - the rails gem is (mostly) just a
stub that provides the rails executable, bit of bootstrapping and just
depends on the main framework gems (activerecord, activeresource,
activesupport etc…). Those frameworks do have rdoc.

Fred

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