耙子中止！不知道如何建设任务“DOC：应用”

的official documentation indicates，我应该能够建立文档使用rake doc:app我的应用程序，但是当我运行在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)

来源

2016-04-22 Brad Werth

此功能是removed from Rails在版本5以下理由：

...在我们的经验应用程序中使用的文档不生成API：应用程序......如果一支球队绝对需要生成应用程序文档为内部的目的，他们仍然可以轻松Ÿ写自己的任务...

的功能可以通过创建/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 --main README.md --title 'My Fancy Title' README.md app/**/*.rb lib/**/*.rb

来源

2016-04-22 22:49:47

如果你有旧的应用程序，你可能想README.md改变README.rdoc在： rdoc.rdoc_fi les.include（ 'README.md'） –

耙子中止！不知道如何建设任务“DOC：应用”

回答

相关问题