如何为(所有)Rails生成RDOC？

Question

我可以

sudo gem rdoc activerecord --no-ri

和

sudo gem rdoc actionpack --no-ri

这两个都给了我很好的文档.

但

sudo gem rdoc rails --no-ri

因为Rails宝石本身只是其他人的持有者,所以几乎没有给我任何东西.如何生成相应的http://api.rubyonrails.org/？

Answer 1

sudo gem rdoc --all --overwrite

Answer 2

我发现最简单的方法是从railsapi.com下载它们并将文件解压缩到/Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

Answer 3

如果您使用rdoc安装rails(sudo gem install rails)您可以通过它访问它

gem server

Answer 4

下面是我尝试澄清有关如何将rails 3.1文档本地下载到您的机器上的步骤,相当于http://api.rubyonrails.org/

1. 转到https://github.com/voloko/sdoc上的sdoc项目并获取项目(或者只是做gem install sdoc)
2. 访问https://github.com/rails/rails上的rails项目,然后将其克隆到本地计算机
3. 进入rails clone并运行sdoc -N rails
4. 这需要一段时间.完成后,您将拥有一个名为doc的新目录
5. 您可以将doc目录移动到任何您喜欢的位置,并在浏览器中打开index.html文件.请注意,您无需使用Web服务器即可运行此功能.

作为旁注,看起来sdoc正式成为Ruby on Rails API的文档(参见http://weblog.rubyonrails.org/2011/8/29/the-rails-api-switches-to-sdoc)