2011-12-07 5 views
3

rake doc:appを入力するとdoc/README_FOR_APPの内容がdoc/app/index.htmlに表示されます。README_FOR_APPの内容をdoc/app/index.htmlに表示する方法

現在、内容は次のとおりです。

これはRailsアプリケーションのドキュメントのためのAPIドキュメントです。

README_FOR_APPを見るには、左側のページのリストでREADME_FOR_APPをクリックする必要があります。

私はHow to Rename or Move Rails's README_FOR_APPを見ましたが、OPは彼がであることを既に肯定しています。私が望むふるまいを見ています。

私はレール3.1.3を使用しています。

答えて

8

まず、プロジェクトに新しいレーキファイル(たとえばlib/tasks/documentation.rake)を作成します。次に、レーキタスクを再定義します。

Rake::Task["doc:app"].clear 
Rake::Task["doc/app"].clear 
Rake::Task["doc/app/index.html"].clear 

namespace :doc do 
    Rake::RDocTask.new('app') do |rdoc| 
     rdoc.rdoc_dir = 'doc/app' 
     rdoc.title = 'YOUR_TITLE' 
     rdoc.main  = 'doc/README_FOR_APP' # define README_FOR_APP as index 

     rdoc.options << '--charset' << 'utf-8' 

     rdoc.rdoc_files.include('app/**/*.rb') 
     rdoc.rdoc_files.include('lib/**/*.rb') 
     rdoc.rdoc_files.include('doc/README_FOR_APP') 

    end 
end 
+0

ありがとう、サム、それは完璧です。 – sheldonh

+0

これはおそらく時代遅れです: 'タスク' doc:app 'を作成する方法がわからない( - タスクを参照) /<...> /lib/tasks/documentation.rake:1:in '' – elsurudo

関連する問題