为本地安装的 gem 生成 RDOC答案

【问题标题】：Generating RDOCs for locally installed gems为本地安装的 gem 生成 RDOC
【发布时间】：2011-04-25 18:15:43
【问题描述】：

我正在努力为我最近感兴趣的一颗宝石 - 内斯塔做出贡献。开发人员在创建您能找到的最轻、最薄的 CMS 之一方面做得很好，我想记录下来。据我所知，我已通读代码并评论了一些方法。

但是，我通过调用gem server 并在将其推送到网上之前查看我的机器上的更改来寻求在本地对此进行测试。

我尝试过的事情：

一切都无济于事。请帮忙。
谢谢。

【问题讨论】：

【解决方案1】：

您可以预览生成的 html 页面，而无需在您的机器上安装 gem 的修改版本。将此添加到内斯塔的 Rakefile：

require 'rake/rdoctask'
Rake::RDocTask.new('doc') do |i|
  i.rdoc_files = FileList['lib/**/*']
end

然后输入rake doc。然后查看生成的html/index.html文件。

【讨论】：

【解决方案2】：

你确定你安装的是你修改过的版本，而不是原来的版本？

如果你安装了修改后的版本，但忘记安装 rdoc，请参阅Can you install documentation for existing gems?

【讨论】：