4

我将 Ruby on Rails 3.1.0 和YARD 0.7.4 gem 用于文档目的。除了此处README生成的文档顶部的文件之外,我还想添加更多文件(请参阅“文件列表”部分下链接页面顶部的、、、、 ...选项卡)。READMEWhat's New?Getting Started GuideArchitecture Overview

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

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

4

1 回答 1

4

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

您还可以在项目目录中添加一个 .yardopts 文件,该文件列出了由空格(换行符或空格)分隔的开关,以便在运行时传递给 yardoc。

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

YARD本身的.yardopts 文件包含:

-
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

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

于 2012-02-18T15:38:24.120 回答