如何記錄除`README`文件以外的更多文件？

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文件到您的項目目錄，其中列出由空格（換行或空格）分隔開的開關傳遞給當它運行時。

以上提示，通過使用- 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 

我認爲這解釋了爲什麼所有這些文件的文件的一部分。不過，我不知道它們是否可以自動作爲選項卡。