creando Rdoc para una aplicación de rieles

Question

Me gustaría generar una documentación para mi proyecto de rieles (2.3.8). Cuando traté

rake doc:rails 
rake doc:rerails 

Se crea la documentación de todas las clases, incluyendo clases de rubí estándar y todos los archivos en el directorio de proveedores de rubí (plugins, etc ..)

¿Cómo puedo crear documentación rdoc sólo para las clases de rubí, archivos en directorios siguientes

1. carpeta app (todos los modelos, controladores y vistas)
2. carpeta de configuración
3. carpeta lib

Answer 1

He añadido esto a mi 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 

Then run;

rake rdoc 

Mira la rdoc documentos de tareas para :: más http://rdoc.rubyforge.org/RDoc/Task.html

verdad es que yo soy una carriles 3 aplicación, pero creo que esto funciona de la misma.

Answer 2

Puede usar rake doc:app para generar documentación para la aplicación.

Citando de la sección 2.4 del Rails guides:

El doc: espacio de nombres tiene las herramientas para generar la documentación para su aplicación , documentación de la API, guías. La documentación también se puede quitar , que es principalmente útil para adelgazar su base de código, como si estuviera escribiendo una aplicación Rails para una plataforma incrustada.

rake doc: la aplicación genera documentación para su aplicación en doc/app. rake doc: guides genera guías de rieles en doc/guides. rake doc: rails genera documentación API para Rails en doc/api.