如何为（所有）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（sudo gem install rails）安装了rails，则可以通过以下方式访问它

gem server

Answer 4

以下是我的尝试，以澄清一些步骤，以了解如何获取与本地http://api.rubyonrails.org/等效的Rails 3.1文档下载到您的计算机。

1. 转到位于https://github.com/voloko/sdoc的sdoc项目并获取该项目（或只是执行gem install sdoc）
2. 访问位于https://github.com/rails/rails的rails项目，并将其git克隆到本地计算机
3. 进入rails克隆并运行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 ）

Answer 5

您可以在应用程序中冻结Rails并运行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

在命令行上运行命令bundle exec rdoc 。

它将生成代码的所有文档。

Answer 7

从Rails项目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 8

如果您需要生成Edge文档，则可以执行以下操作

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 9

$ 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