2016-04-22 6 views
0

私はrake doc:appを使用して自分のアプリケーションのドキュメントを構築することができるはずですofficial documentation indicatesが、私はRailsの5でコマンドを実行すると、私は次の出力を取得:タスクを構築する方法を知ってはいけないレイクは中止! 「:アプリDOC」

[email protected]:~/rails/gep$ rake doc:app 
rake aborted! 
Don't know how to build task 'doc:app' (see --tasks) 

(See full trace by running task with --trace) 

答えて

2

この機能は、次の正当性と、バージョン5でremoved from Railsた:私たちの経験のアプリケーションはドキュメント使用してAPIを生成しないで...

:アプリを...チームは絶対のためのアプリケーションのマニュアル を生成する必要がある場合内部的な目的は、彼らはまだeasil yは、自分のタスクを書く...

機能は簡単に、次の内容で/lib/tasks/documentation.rakeでファイルを作成することにより、復元されたlast version of the official taskから撮影することができます。

# /lib/tasks/documentation.rake 
require 'rdoc/task' 

namespace :doc do 
    RDoc::Task.new("app") { |rdoc| 
    rdoc.rdoc_dir = 'doc/app' 
    rdoc.template = ENV['template'] if ENV['template'] 
    rdoc.title = ENV['title'] || 'Rails Application Documentation' 
    rdoc.options << '--line-numbers' 
    rdoc.options << '--charset' << 'utf-8' 
    rdoc.rdoc_files.include('README.md') 
    rdoc.rdoc_files.include('app/**/*.rb') 
    rdoc.rdoc_files.include('lib/**/*.rb') 
    } 
    Rake::Task['doc:app'].comment = "Generate docs for the app -- also available doc:rails, doc:guides (options: TEMPLATE=/rdoc-template.rb, TITLE=\"Custom Title\")" 
end 

rdoc.rdoc_fi:あなたは、レガシーアプリを持っている場合あなたがREADME.rdocにREADME.mdを変更する場合があります

rdoc --main README.md --title 'My Fancy Title' README.md app/**/*.rb lib/**/*.rb 
+1

:この時点では、ほとんどのコマンドラインから、ちょうどこのような何かを実行しやすいようだ、が、 les.include( 'README.md') –

関連する問題