如何为（全部）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

我发现是刚刚从railsapi.com下载它们并解压缩文件到/Library/Ruby/Gems/1.8/doc/rails-2.3.3/rdoc/

Answer 2

从Rails project Rakefile

desc "Generate documentation for the Rails framework" 
Rake::RDocTask.new do |rdoc| 
    rdoc.rdoc_dir = 'doc/rdoc' 
    rdoc.title = "Ruby on Rails Documentation" 

    rdoc.options << '--line-numbers' << '--inline-source' 
    rdoc.options << '-A cattr_accessor=object' 
    rdoc.options << '--charset' << 'utf-8' 

    rdoc.template = ENV['template'] ? "#{ENV['template']}.rb" : './doc/template/horo' 

    rdoc.rdoc_files.include('railties/CHANGELOG') 
    rdoc.rdoc_files.include('railties/MIT-LICENSE') 
    rdoc.rdoc_files.include('railties/README') 
    rdoc.rdoc_files.include('railties/lib/{*.rb,commands/*.rb,rails/*.rb,rails_generator/*.rb}') 

    rdoc.rdoc_files.include('activerecord/README') 
    rdoc.rdoc_files.include('activerecord/CHANGELOG') 
    rdoc.rdoc_files.include('activerecord/lib/active_record/**/*.rb') 
    rdoc.rdoc_files.exclude('activerecord/lib/active_record/vendor/*') 

    rdoc.rdoc_files.include('activeresource/README') 
    rdoc.rdoc_files.include('activeresource/CHANGELOG') 
    rdoc.rdoc_files.include('activeresource/lib/active_resource.rb') 
    rdoc.rdoc_files.include('activeresource/lib/active_resource/*') 

    rdoc.rdoc_files.include('actionpack/README') 
    rdoc.rdoc_files.include('actionpack/CHANGELOG') 
    rdoc.rdoc_files.include('actionpack/lib/action_controller/**/*.rb') 
    rdoc.rdoc_files.include('actionpack/lib/action_view/**/*.rb') 
    rdoc.rdoc_files.exclude('actionpack/lib/action_controller/vendor/*') 

    rdoc.rdoc_files.include('actionmailer/README') 
    rdoc.rdoc_files.include('actionmailer/CHANGELOG') 
    rdoc.rdoc_files.include('actionmailer/lib/action_mailer/base.rb') 
    rdoc.rdoc_files.exclude('actionmailer/lib/action_mailer/vendor/*') 

    rdoc.rdoc_files.include('activesupport/README') 
    rdoc.rdoc_files.include('activesupport/CHANGELOG') 
    rdoc.rdoc_files.include('activesupport/lib/active_support/**/*.rb') 
    rdoc.rdoc_files.exclude('activesupport/lib/active_support/vendor/*') 
end 

# Enhance rdoc task to copy referenced images also 
task :rdoc do 
    FileUtils.mkdir_p "doc/rdoc/files/examples/" 
    FileUtils.copy "activerecord/examples/associations.png", "doc/rdoc/files/examples/associations.png" 
end 

Answer 3

如果使用RDoc的安装导轨（sudo的创业板安装导轨） 您可以通过

gem server 

Answer 4

访问它。如果你需要生成边缘文档，你可以执行类似这样的操作

git clone git://github.com/rails/rails.git ~/rails 
# or if you have repo, just checkout interested branch 
cd ~ 
ruby ~/rails/railties/bin/rails docapp 
cd docapp 
ln -s ~/rails vendor/rails 
rake doc:rerails 
rake doc:guides 

Answer 5

您可以冻结导入一个应用程序并运行rake doc:rails获取文档。

rails doc_project 
cd doc_project 
rake rails:freeze 
rake doc:rails 

RDocs应位于doc/api目录中。您可以使用rake rails:freeze:edge获取Edge Rails的文档。

或者，您可以从像Rails Brain这样的站点下载文档，以获得可搜索的模板。

如果您要将文档显示在gem server中，那么最简单的方法是使用rdoc选项重新安装rails gem。

sudo gem install rails --rdoc 

Answer 6

$ rake rails:freeze:gems 
$ rake doc:rails 
$ rake rails:unfreeze 
$ sudo mv doc/api/* /Library/Ruby/Gems/1.8/doc/rails-2.3.5/rdoc 
$ gem server 

Answer 7

sudo gem rdoc --all --overwrite 

Answer 8

下面是我试图澄清的步骤如何让铁轨一点最简单的3.1文档本地下载到您的机器上相当于http://api.rubyonrails.org/

1. 转到sdoc项目T取代https://github.com/voloko/sdoc并获得项目（或只是创业板安装SDOC）
2. 访问在https://github.com/rails/rails Rails项目和混帐克隆它到本地机器上
3. 走进铁轨克隆和运行SDOC -N轨
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）

Answer 9

运行命令行命令bundle exec rdoc。

它会生成您的代码的所有文档。