使用Yard在Rails应用程序文档中对类进行分组

Question

是否有插件以对Rails应用程序有意义的方式格式化文档？

我一直在尝试使用Yard，但是它将所有Model和Controller类都放在顶层名称空间下。有什么办法可以将它们视为模块，以便将它们全部分组在一起？

我要使用的结构与Rails应用通常的结构相同，即

-Models
----ModelClass1
----ModelClass2
----ModelClass3
-Controllers
----ControllerClass1
----ControllerClass2
----ControllerClass3

但是院子文档生成器吐出的是

-ModelClass1
-ModelClass2
-ModelClass3
-ControllerClass1
-ControllerClass2
-ControllerClass3

Answer 1

我有相同的目标，并在YARD GitHub中提出了一个问题。他们向我指出了使用自定义类列表菜单结构的aws-sdk gem。我设法用它创建了一个通用的Rails布局，该布局大致模拟了app/的文件夹结构。

您可以在this gist中的第3步中签出我的代码（如果尚未创建模板目录结构，则可能需要备份到第2步）。