creazione di Rdoc per un'applicazione di rotaie

Question

Vorrei generare una documentazione per il mio progetto di binari (2.3.8). Quando ho provato

rake doc:rails 
rake doc:rerails 

Si crea la documentazione per tutte le classi comprese le classi rubino standard e tutti i file nella directory rubino vendor (plugins, ecc ..)

Come posso creare documentazione rdoc solo per le classi rubino, file nelle seguenti directory

1. cartella applicazione (tutti i modelli, i controller e viste)
2. cartella config
3. cartella lib

Answer 1

Ho aggiunto questo al mio Rakefile;

RDoc::Task.new :rdoc do |rdoc| 
    rdoc.main = "README.rdoc" 

    rdoc.rdoc_files.include("README.rdoc", "doc/*.rdoc", "app/**/*.rb", "lib/*.rb", "config/**/*.rb") 
    #change above to fit needs 

    rdoc.title = "App Documentation" 
    rdoc.options << "--all" 
end 

Quindi eseguire;

rake rdoc 

Scopri i rdoc :: documentazione Operazione Per ulteriori http://rdoc.rubyforge.org/RDoc/Task.html

Certo io sono su una rotaie 3 app, ma credo che questo funziona lo stesso.

Answer 2

È possibile utilizzare rake doc:app per generare documentazione per l'app.

Citando dal punto 2.4 Rails guides:

Il dottore: namespace ha gli strumenti per generare la documentazione per il vostro app, documentazione API, guide. La documentazione può anche essere rimossa che è principalmente utile per snellire il codice base, come se tu sia scrivendo un'applicazione Rails per una piattaforma incorporata.

rake doc: l'app genera la documentazione per l'applicazione in doc/app. rake doc: guide genera guide di Rails in doc/guide. rake doc: rails genera documentazione API per Rails in doc/api.