Ruby and Ruby on Rails offline API documentation

ruby-on-rails ruby api documentation
denisjacquemin picture denisjacquemin · Mar 13, 2010 · Viewed 19.9k times · Source

In the past I used railsbrain.com to have a nice and handy offline api documentation.

But they stop at version 2.3.2

Is there any other solution with latest version.

Answer

guzart picture guzart · Oct 16, 2011

Browser-based Solution – Updated Oct 19, 2017

DevDocs (https://devdocs.io/) uses your browser's IndexedDB to store the documentation you want. Make sure you follow the instructions on how to install the docs before you go offline.

For macOS try Dash

For Windows/Linux try Zeal

For packaged HTML try RubyDocs

Manual Download:

I used this commands on my server so I could get the files faster (they were cached, go figure).

wget -r -k -p http://api.rubyonrails.org/

  • r - recursive
  • k - convert links to point to local files
  • p - get all images, etc needed to display the html pages

Then I compress the folder so I can download it without overhead.

rar a -r rails_api.rar api.rubyonrails.org/

  • a - add files
  • r - recursive

https://gist.github.com/2149669

YARD Server

I prefer the yard format over rdoc.

  1. Install the gem gem install yard,
  2. Regenerate all the documentation gem rdoc --all --overwrite, and
  3. Run the server for the gems yard server --gems.

Related questions

Devise API authentication

I am working on a rails web application that also provides JSON based API for mobile devices . mobile clients are expected to first obtain a token with (email/pass), then clients will make subsequential API calls with the token. I …

Read More
ruby on rails, creating new object, use create or new method?

I am trying to create an object via an API, i.e. no forms are required, should I be doing MyModel.new(:name => params[:name]) or MyModel.create(:name => params[:name]) ? Assume I have resources : my_models in …

Read More
How do I generate RDOC for (all of) Rails?

I can do sudo gem rdoc activerecord --no-ri and sudo gem rdoc actionpack --no-ri both of which give me good docs. But sudo gem rdoc rails --no-ri gives me pretty much nothing, as the Rails gem itself is really just …

Read More