readme_for_appの内容を作成する方法doc/app/index.htmlに表示される

StackOverflow https://stackoverflow.com/questions/8415676

  •  29-10-2019
  •  | 
  •  

質問

の内容が欲しいです doc/README_FOR_APP に表示されます doc/app/index.html, 、 私がする時 rake doc:app.

現在、コンテンツは次のとおりです。

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

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

私は見ました Railsのreadme_for_appの名前を変更または移動する方法 しかし、OPは彼がそうであると主張しています すでに 私が欲しい行動を見ています。

Rails 3.1.3を使用しています。

役に立ちましたか?

解決

まず、新しいレーキファイルを作成します(例: 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
ライセンス: CC-BY-SA帰属
所属していません StackOverflow
scroll top