Rails 3 中 RDoc 的插件文档

发布于 2024-11-26 10:53:55 字数 139 浏览 1 评论 0原文

我正在编写一个 Rails 3 插件并使用引擎。我的插件中有 app/ 文件夹,其中包含控制器、模型和视图。

问题是,当我想使用 RDoc 生成文档时,它不会进入 app/ 文件夹来解析其中的文件。我是否必须传递一个选项,以便它知道在哪里搜索它们?

I'm writing a Rails 3 plugin and I'm using Engines. I have and app/ folder in my plugin with controller, models and views.

The problem is that when I want to generate documentation with RDoc it won't go into the app/ folder to parse the files in there. Is there an option I have to pass to it so it will know where to search for them?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(1

对风讲故事 2024-12-03 10:53:55

我最终自己弄清楚了。我使用 rake 任务来生成文档

rake doc:plugins

这会运行 rdoc 命令,但它会传递要解析的文件。
我最终通过直接在我的插件文件夹中使用 rdoc 解决了这个问题,如下所示:

rdoc -o doc/plugins/my_plugin --title "My plugin Docs" --line-numbers --all --main README

I eventually figured it out on my own. I was using the rake task to generate documentation

rake doc:plugins

This runs the rdoc command but it passes the files to be parsed.
I eventually got around this by using rdoc directly in my plugin folder like so:

rdoc -o doc/plugins/my_plugin --title "My plugin Docs" --line-numbers --all --main README
~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文