Question

我正在使用Ruby on Rails 3.1.0和YARD 0.7.4 gem来进行文档编制。我想在生成的文档顶部添加除README文件之外的更多文件here（请参阅README，What's New?，Getting Started Guide，位于“文件列表”部分下的链接页面顶部的Architecture Overview，... 标签。

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

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

Answer 1

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

您还可以将.yardopts文件添加到项目目录中，该目录列出了由空格（换行符或空格）分隔的开关，以便在运行时传递给yardoc。

上面有提示，通过使用- 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

我认为这解释了为什么所有这些文件都是文档的一部分。不过，我不知道它们是否可以自动显示。

如何记录除`README`文件以外的更多文件？

1 个答案: