Ruby yard ドキュメントにファイルが表示されない
質問
これが私のセットアップです:
- Ruby 1.9.2 p290
- ヤード0.8.1
フォルダー構造は gem ではなく、単なる古い Ruby コードです。
.
├── classes
│ ├── crawl.rb
│ └── page.rb
└── run.rb
問題は、yard がファイルを認識しないことです。
yard doc
次の出力が得られます。
Files: 0
Modules: 0 ( 0 undocumented)
Classes: 0 ( 0 undocumented)
Constants: 0 ( 0 undocumented)
Methods: 0 ( 0 undocumented)
0.00% documented
ファイルが表示されない、または表示されない理由が何か考えられますか?
編集 (追加情報):
Yard にはファイルを作成する権限があります。
を実行した後、 yard doc
コマンドを実行すると、ディレクトリに yard ファイルが表示されます。
. .. .yardoc classes doc run.rb
編集 (rdoc に関するコメントへの応答)
yard が作成した doc フォルダーを削除したら (rdoc がそれについて文句を言います) rm -rf doc
, 、rdoc はドキュメントを生成し、この出力を提供します
Files: 7
Classes: 6 ( 4 undocumented)
Modules: 0 ( 0 undocumented)
Constants: 2 ( 2 undocumented)
Attributes: 18 (18 undocumented)
Methods: 24 (20 undocumented)
Total: 50 (44 undocumented)
12.00% documented
編集(追加情報)
Yard は、MRI 1.8.7 や jRuby 1.6.4 などの他の Ruby ビルドでは機能しません。上で説明したのと同じように動作します
解決
Yard は、ディレクトリ構造内のすべての Ruby ファイルを自動的に文書化するわけではありません。ファイルを検索します ./lib
ディレクトリ。他のものを文書化したい場合は、コマンドまたは .yardopts ファイルでそれを指定する必要があります。
例yard classes/*.rb *.rb
所属していません StackOverflow