使用 Yard 對 Rails 應用文檔中的類進行分組

Question

是否有插件以對 Rails 應用程序有意義的方式格式化文檔？

我一直在嘗試使用 Yard，但它將所有模型和控制器類放在頂級命名空間下。 有沒有辦法讓它將它們視為模塊，以便它們全部組合在一起？

我要使用的結構與 Rails 應用程序的通常結構相同，即

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

但是院子里的文檔生成器吐出來的是

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

Answer 1

我有同樣的目標，並在 YARD GitHub 中提出了一個問題。 他們向我指出了使用自定義類列表菜單結構的 aws-sdk gem。 我設法使用它來創建一個通用的 Rails 布局，大致模仿app/的文件夾結構。

您可以在此要點的第 3 步下查看我的代碼（如果您還沒有，則可能需要備份到第 2 步以創建模板目錄結構）。