Cómo hacer que el contenido de ReadMe_For_App aparezca en DOC/App/Index.html

Question

Quisiera el contenido de doc/README_FOR_APP aparecer en doc/app/index.html, Cuando lo hago rake doc:app.

Actualmente, el contenido es:

Esta es la documentación de API para la documentación de la aplicación Rails.

Para ver README_FOR_APP, Tengo que hacer clic en README_FOR_APP en la lista de páginas a la izquierda.

He mirado Cómo cambiar el nombre o mover el readMe_for_app de Rails Pero el OP afirma que es ya Ver el comportamiento que quiero.

Estoy usando Rails 3.1.3.

Answer 1

En primer lugar, cree un nuevo archivo de rastrillo (por ejemplo, lib/tasks/documentation.rake) en tu proyecto. Luego redefine la tarea de rastrillo:

Rake::Task["doc:app"].clear
Rake::Task["doc/app"].clear
Rake::Task["doc/app/index.html"].clear

namespace :doc do
    Rake::RDocTask.new('app') do |rdoc|
        rdoc.rdoc_dir = 'doc/app'
        rdoc.title    = 'YOUR_TITLE'
        rdoc.main     = 'doc/README_FOR_APP' # define README_FOR_APP as index

        rdoc.options << '--charset' << 'utf-8'

        rdoc.rdoc_files.include('app/**/*.rb')
        rdoc.rdoc_files.include('lib/**/*.rb')
        rdoc.rdoc_files.include('doc/README_FOR_APP')

    end
end