Api.rubyonrails.org previous versions?

Rails
1

First, let me say that api.rubyonrails.org is awesome. Whoever is
hosting
it - thank you. It blows all the other api tools out of the water in
terms
of usability. Yay!

That said, how come Ruby on Rails API doesn’t show me
the
3.0.15 docs? 3.0.x is still actively maintained and supported. What
about
any other old version. I’m sure some folks would find this very useful.
It
is exceedingly difficult to get decent-to-use docs for old versions of
rails.

Think we can make that happen somehow?

Love,
Josh

P.S. Same could be said for the guides.rubyonrails.org. I’m
aware Ruby on Rails guides is available, but that’s
just
because it’s ingrained. As far as I can tell it’s not readily linked to
anymore. Are there other versions of the guides?

2

On Jul 11, 2012, at 3:12 PM, Josh wrote:

First, let me say that api.rubyonrails.org is awesome. Whoever is hosting it -
thank you. It blows all the other api tools out of the water in terms of
usability. Yay!

That said, how come Ruby on Rails API doesn’t show me the
3.0.15 docs? 3.0.x is still actively maintained and supported. What about any
other old version. I’m sure some folks would find this very useful. It is
exceedingly difficult to get decent-to-use docs for old versions of rails.

Think we can make that happen somehow?

Have you tried apidock yet? That has a picker for what version you are
using, and shows when a particular function was deprecated. Very handy
for this sort of thing.

Walter

3

On Jul 11, 8:12pm, Josh [email protected] wrote:

Think we can make that happen somehow?

even if the powers that be don’t want to make it happen

cd your_app
touch README.rdoc
rake doc:rails

This will dump the rdoc documentation for the rails version in doc/
api.

Unfortunately at the moment that will use a different template to
api.rubyonrails.org (if you’re using an older version of rails it
might not matter)

You can hack things by:

  • adding sdoc to your bundle
  • edit documentation.rake (in the railties gem) and add

require ‘sdoc’ #at the top of the file

Change the options passed to rdoc in the rails task

rdoc.options << ‘–line-numbers’
rdoc.options << ‘-f’ << ‘sdoc’
rdoc.options << ‘-T’ << ‘rails’
rdoc.options << ‘-e’ << ‘UTF-8’

Remove doc/api, rerun rake doc:api and you should have api docs that
look like the ones on api.rubyonrails.org (you need to serve them
through an actual web server (e.g. thin -A file start), the links
don’t work when accessed via file:/// urls)

You can generate the guides too. First check that you have the
RedCloth gem in your bundle. then run rake doc:guides and all the
guides will be generated in doc/guides

P.S. Same could be said for the guides.rubyonrails.org. I’m
awarehttp://guides.rubyonrails.org/v2.3.8/is available, but that’s just
because it’s ingrained. As far as I can tell it’s not readily linked to
anymore. Are there other versions of the guides?

The guides front page links to Ruby on Rails guides
Seems like you can pop any 3.1.x or 3.2.x version number in there

Fred

4

Yea, I know how to generate my own docs, and apidock is… okay. Both
of
the proposed solutions so far are missing the point.
api.rubyonrails.org
should host, at a minimum, all currently supported versions. Once
that’s
done it should be trivial to support as far back as the docs remain in
the
same format.

5

I strongly support Josh’s opinion. It’s extremely hard to find
information
on specific rails versions and you can’t even tell which version you’re
currently following when you’re reading a guide. It’s a pity that the
maintainers seem to not care much about people not living on the edge.
What about a delivery point where people could drop the documentation
they’ve generated for specific releases and make it available to the
community?
MySQL for example has a full set of documentation for each release …

Am Samstag, 14. Juli 2012 14:15:52 UTC+2 schrieb Josh: