如何记录除“README”文件之外的更多文件？
我正在使用 Ruby on Rails 3.1.0 和 YARD 0.7.4用于文档目的的 gem。我想在生成的文档顶部添加除 README 文件之外的更多文件 此处（请参阅自述文件、新增内容？、入门指南、架构概述、. .. 链接页面顶部的选项卡在“文件列表”部分下）。
也就是说，默认情况下，YARD gem 似乎只生成与我的 RoR 应用程序的 ROOT 目录中存在的 README 文件相关的文档。我想记录其他文件，并为每个文件在文档顶部添加一个选项卡（如前面链接的页面中所做的那样）。
可能吗？如果是这样，我该如何做到这一点？此外，我应该创建一个新目录（在我的 RoR 应用程序的根目录中），其中包含用于文档目的的“自定义”文件吗？
I am using Ruby on Rails 3.1.0 and the YARD 0.7.4 gem for documentation purposes. I would like to add more files other than the README file on the top of the generated documentation as made here (see README, What's New?, Getting Started Guide, Architecture Overview, ... tabs at the top of the linked page under the "File Listing" section).
That is, by default the YARD gem seems to generate only the documentation related to the README file present in the ROOT directory of my RoR application. I would like to document other files and for each of them add a tab at the top of the documentation (as made in the previously linked page).
Is it possible? If so, how can I make that? More, should I create a new directory (in the ROOT of my RoR application) containing my "custom" files used for documentation purposes?
如果你对这篇内容有疑问，欢迎到本站社区发帖提问 参与讨论，获取更多帮助，或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱，如果其他用户或者作者回复了您的评论，将不能在第一时间通知您！
发布评论
评论（1）
在阅读 YARD：命令行工具 的文档时，您会发现以下内容：
上面有提示，通过使用
- README LICENSE FAQ，这些文件将被添加到文档中。YARD 的 .yardopts 文件 本身包含：
我认为这解释了为什么所有这些文件是文档的一部分。不过，我不知道它们是否可以自动作为选项卡使用。
When reading the documentation for YARD: Command line tool, you will find the following:
Above, there is the hint that by using
- README LICENSE FAQ, these files will be added to the documentation.The .yardopts file for YARD itself contains:
I think that explains why all these files are part of the documentation. I don't know if they are available as tabs automatically, though.