`README`ファイル以外のファイルをもっと文書化するには？

Question

私はRuby on Rails 3.1.0とYARD 0.7.4 gemをドキュメント化の目的で使用しています。 here（...、README、What's New?、Getting Started Guide、Architecture Overviewを参照してくださいタブは「ファイルリストの下のリンク先のページの一番上に作られたように私は、生成されたドキュメントの上にREADMEファイル以外のファイルを追加したいと思います" セクション）。

つまり、デフォルトでYARD gemはRoRアプリケーションのROOTディレクトリにあるREADMEファイルに関するドキュメントのみを生成しているようです。私は他のファイルを文書化したいと思いますし、それぞれのために（前にリンクされたページのように）ドキュメントの上部にタブを追加してください。

可能でしょうか？もしそうなら、どうしたらいいですか？さらに、ドキュメンテーションの目的で使用される「カスタム」ファイルを含む新しいディレクトリ（RoRアプリケーションのルート）を作成する必要がありますか？ YARD: Command line toolのマニュアルを読むとき、あなたは以下があります

Answer 1

：

ます。また、空白（改行やスペース）で区切ってスイッチの一覧プロジェクトディレクトリに.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 

私はすべてのこれらのファイルは、文書の一部である、その理由は説明すると思います。彼らがタブとして自動的に利用できるかどうかはわかりません。