Come fare i contenuti di readme_for_app appaiono in doc/app/index.html

Question

Vorrei il contenuto di doc/README_FOR_APP apparire in doc/app/index.html, quando io faccio rake doc:app.

Attualmente, il contenuto è:

Questa è la documentazione API per la documentazione dell'applicazione Rails.

Vedere README_FOR_APP, Devo fare clic su README_FOR_APP Nell'elenco delle pagine a sinistra.

Ho guardato Come rinominare o spostare i readme_for_app di Rails Ma l'OP afferma che lo è già vedere il comportamento che voglio.

Sto usando Rails 3.1.3.

Answer 1

In primo luogo, crea un nuovo file di rastrello (ad esempio lib/tasks/documentation.rake) nel tuo progetto. Quindi ridefinire l'attività di rastrello:

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