Comment faire apparaître le contenu de README_FOR_APP dans doc / app / index.html

Question

J'aimerais que le contenu de doc/README_FOR_APP apparaisse dans doc/app/index.html, quand je fais rake doc:app.

Actuellement, le contenu est:

Voici la documentation de l'API pour la documentation de l'application Rails.

Pour voir README_FOR_APP, je dois cliquer sur README_FOR_APP dans la liste des pages à gauche.

J'ai regardé Comment renommer ou déplacer des railsREADME_FOR_APP mais l'OP affirme qu'il est déjà en train de voir le comportement que je souhaite.

J'utilise des rails 3.1.3.

Answer 1

Tout d'abord, créez un nouveau fichier rake (par exemple, lib/tasks/documentation.rake) dans votre projet.Puis redéfinissez la tâche de râteau:

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