Rake abgebrochen! Sie wissen nicht, wie Aufgabe zu bauen ‚doc: app‘

Question

Die official documentation indicates, dass ich in der Lage sollte Dokumentation für meine Anwendung erstellen mit rake doc:app, aber wenn ich den Befehl in Rails 5 I erhalten die folgende Ausgabe:

bwerth@bwerth-VirtualBox:~/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) 

Answer 1

Diese Funktionalität war removed from Rails in Version 5 mit folgenden Begründung:

... in unserer Erfahrung Anwendungen erzeugen keine APIs doc mit: App ... Falls unbedingt ein Team Anwendungsdokumentation erzeugen muss für interne Zwecke können sie noch erleichtern y ihre eigene Aufgabe schreiben ...

Die Funktionalität kann leicht durch Erstellen einer Datei auf /lib/tasks/documentation.rake mit folgendem Inhalt wiederhergestellt werden, vom last version of the official task genommen:

# /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 

Obwohl es scheint, an dieser Stelle fast einfacher, nur in etwa so läuft, von der Kommandozeile:

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