Where to download api documentation?

Rails
1

Hello, I need to download the api doc and would like to avoid vaccuuming
api.rubyonrails.org

Is there a .chm version ? Or at least a zipped html version somewhere ?

Thanks

2

nuno wrote:

Hello, I need to download the api doc and would like to avoid vaccuuming
api.rubyonrails.org

If you have Rails installed on your machine, then you already have the
documentation installed – it’s wrapped up inside the Rails code. There
are two ways to get at it:

  1. If you want to view documentation for the gems you have installed,
    run ‘gem_server’ from the command line, and point your web browser at
    http://localhost:8808/.

  2. If you’re frozen against edge Rails, and you want to generate the
    documentation in the same style as api.rubyonrails.org, go into your
    Rails app directory and run ‘rake doc:rails’ to generate the
    documentation inside /doc/api.

Chris

3

nuno wrote:

Hello, I need to download the api doc and would like to avoid vaccuuming
api.rubyonrails.org

Is there a .chm version ? Or at least a zipped html version somewhere ?

When you install Gems, the relevant HTML documentation (RDoc) is
generated for you. If you open a command window and type

gem_server

you should see something like:

[2006-08-26 15:23:26] INFO WEBrick 1.3.1
[2006-08-26 15:23:26] INFO ruby 1.8.2 (2004-12-25) [i386-mswin32]
[2006-08-26 15:23:26] INFO WEBrick::HTTPServer#start: pid=1828
port=8808

You should then be able to browse http://localhost:8808/
to see the documentation.

regards

Justin

4

Thanks for your answers, I was completely unaware of this trick ! RoR
world is full of surprises :wink:

5

On 8/26/06, nuno [email protected] wrote:

Thanks for your answers, I was completely unaware of this trick ! RoR
world is full of surprises :wink:

Technically this is a feature of rubygem and rdoc. RoR just simply has
this doc like most others.

–

Jon Gretar B.
http://www.jongretar.net/

6

Nuno,

1/

Is there a .chm version ?

http://delynnberry.com/pages/rails-chm-documentation/

(MacOS X users can read chm files with ‘chamonix’
Chamonix download | SourceForge.net
)

2/
There’s also DevBoi, a Firefox plugin that gives easy access to
various documentations.
http://devboi.mozdev.org/
You can even have it install local/offline version of some docs.

Alain