如何生成与我的插件相关的文档?

时间:2012-01-20 21:42:35

标签: ruby-on-rails ruby ruby-on-rails-3 documentation yard

我正在使用Rails 3.1.0,我已经实现了一个有效的插件。除了应该这样做,其相关文件位于ROOT_APP/vendor/plugins/my_plugin目录。

现在,我正在使用YARD 0.7.4 gem,我想记录该插件。无论如何,当我运行yardoc(或yard doc)命令时,似乎不考虑我的插件,因此不会生成相关文档(仅生成与“主”应用程序相关的文档)。 p>

如何生成与我的插件相关的文档?

1 个答案:

答案 0 :(得分:0)

如果您从插件目录中运行yardoc,则应生成您的文档。