ruby - 为本地安装的 gem 生成 RDOC

Question

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

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

我尝试过的事情：

1. 手动编辑。
   • 记录了文件。
   • 火了起来gem server。
2. 使用该gem工具。
   • 记录了文件。
   • 冉gem rdoc nesta --rdoc
   • 重新启动gem server

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

Answer 1

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

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

和类型rake doc。然后查看生成的html/index.html文件。

Answer 2

Are you sure you've installed the version that you've modified, not the original version?

If you've installed the modified version, but have forgotten to install the rdoc, see Can you install documentation for existing gems?