为本地安装的gem生成RDOC

Question

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

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

我尝试过的事情：

1. 手动编辑。
   • 记录文件。
   • 已解雇gem server。
2. 使用gem工具。
   • 记录文件。
   • 跑gem rdoc nesta --rdoc
   • 重新启动gem server

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

Answer 1

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

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

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

Answer 2

您确定已安装了已修改的版本，而不是原始版本吗？

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