# Offline documentation for ruby on rails

**URL:** <https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966>\
**Category:** Rails\
**Created:** [July 30, 2009, 5:21pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966 "2009-07-30T17:21:17Z")\
**Posts on this page:** 9\
**Page:** 1

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 30, 2009, 5:21pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/1 "2009-07-30T17:21:17Z")

</div>

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

---

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 30, 2009, 5:28pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/2 "2009-07-30T17:28:07Z")

</div>

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](http://railsbrain.com) and [railsapi.com](http://railsapi.com) also offer downloadable versions of  
their Rails docs.

## Best,

Marnen Laibow-Koser  
[http://www.marnen.org](http://www.marnen.org)  
removed\_email\_address@domain.invalid

---

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 30, 2009, 5:34pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/3 "2009-07-30T17:34:29Z")

</div>

On Thu, Jul 30, 2009 at 8:21 AM, Aashish  
Kiran[removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) 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](http://localhost:8808) in a  
browser shows me the rdoc for all the installed gems, including Rails.

## HTH!

Hassan S. ------------------------ removed\_email\_address@domain.invalid  
twitter: @hassan

---

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 30, 2009, 6:40pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/4 "2009-07-30T18:40:39Z")

</div>

On Jul 30, 11:33 am, Hassan S. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
wrote:

> On Thu, Jul 30, 2009 at 8:21 AM, Aashish
> 
> Kiran[removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) 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](http://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

---

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 30, 2009, 8:28pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/5 "2009-07-30T20:28:26Z")

</div>

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](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](http://www.marnen.org)  
removed\_email\_address@domain.invalid

---

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 30, 2009, 9:02pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/6 "2009-07-30T21:02:55Z")

</div>

On Thu, Jul 30, 2009 at 11:28 AM, Marnen  
Laibow-Koser[removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> > there. Running “gem server” and going to [http://localhost:8808](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 🙂

–  
Hassan S. ------------------------ removed\_email\_address@domain.invalid  
twitter: @hassan

---

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 30, 2009, 8:08pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/7 "2009-07-30T20:08:28Z")

</div>

> 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/](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

---

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 31, 2009, 6:48am UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/8 "2009-07-31T06:48:17Z")

</div>

Frederick C. wrote:

> On Jul 30, 11:33ï¿½am, Hassan S. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
> wrote:

> What I do is run rake doc:rails which creates the same docs as on  
> [api.rubyonrails.org](http://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

---

<div class="post-metadata">

**Author:** ![aashishkiran](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/a/4da419/32.png) [@aashishkiran](https://www.ruby-forum.com/u/aashishkiran)\
**Post date:** [July 31, 2009, 1:22pm UTC](https://www.ruby-forum.com/t/offline-documentation-for-ruby-on-rails/172966/9 "2009-07-31T13:22:45Z")

</div>

On Jul 30, 3:01 pm, Hassan S. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
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
