为本地安装的gems生成RDOC

Question

我正试图贡献一个我最近感兴趣的gem - Nesta。开发人员在创建可以找到的最轻，最重要的CMS之一方面做得非常出色，并且我想将其记录下来。据我所知，我已经阅读了代码并评论了几种方法。

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

事情我已经尝试：

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

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

Answer 1

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

如果您已经安装了修改后的版本，但忘记安装RDoc的，看到Can you install documentation for existing gems?

Answer 2

您可以预览生成的html页面没有您的计算机上安装的宝石的修改版本。将此添加到Nesta的Rakefile中：

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

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