ruby-on-rails - 如何记录 `README` 文件以外的更多文件？

Question

我正在使用 Ruby on Rails 3.1.0 和 YARD 0.7.4 gem 用于文档目的。我想在生成的文档顶部添加除 README 文件之外的更多文件 here (请参阅自述文件、新增功能？、入门指南、架构概述、... 选项卡 在链接页面顶部的“文件列表”部分下)。

也就是说，默认情况下，YARD gem 似乎只生成与我的 RoR 应用程序的 ROOT 目录中存在的 README 文件相关的文档。我想记录其他文件，并为每个文件在文档顶部添加一个选项卡(如先前链接页面中所做的那样)。

这可能吗？如果是这样，我该怎么做？此外，我是否应该创建一个新目录(在我的 RoR 应用程序的 ROOT 中)，其中包含用于文档目的的“自定义”文件？

Answer 1

阅读 YARD: Command line tool 的文档时，您会发现以下内容:

You can also add a .yardopts file to your project directory which lists the switches separated by whitespace (newlines or space) to pass to yardoc whenever it is run.

上面有提示，通过使用- README LICENSE FAQ，这些文件将被添加到文档中。

.yardopts file for YARD本身包含:

-
docs/WhatsNew.md
docs/GettingStarted.md
docs/Overview.md
docs/CodeObjects.md
docs/Tags.md
docs/Parser.md
docs/Handlers.md
docs/Templates.md
docs/Glossary.md
ChangeLog
LICENSE
LEGAL

我认为这解释了为什么所有这些文件都是文档的一部分。不过，我不知道它们是否自 Action 为选项卡可用。