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

发布时间：2020-12-17 02:31:07 所属栏目：百科来源：网络整理

导读：我使用 Ruby on Rails 3.1.0和 YARD 0.7.4 gem进行文档编制.我想在生成的文档顶部添加除README文件之外的更多文件,如 here所示(参见README,新增内容,入门指南,体系结构概述,……标签页下方的链接页面顶部) “文件列表”部分). 也就是说,默认情况下,YARD gem

我使用 Ruby on Rails 3.1.0和 YARD 0.7.4 gem进行文档编制.我想在生成的文档顶部添加除README文件之外的更多文件,如 here所示(参见README,新增内容,入门指南,体系结构概述,……标签页下方的链接页面顶部) “文件列表”部分).

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

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

解决方法

阅读 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

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

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!