Как сделать так, чтобы содержимое README_FOR_APP отображалось в doc / app / index.html - PullRequest
Новая
       18

Как сделать так, чтобы содержимое README_FOR_APP отображалось в doc / app / index.html

3 голосов
/ 07 декабря 2011

Мне бы хотелось, чтобы содержимое doc/README_FOR_APP отображалось в doc/app/index.html, когда я делаю rake doc:app.

В настоящее время содержимое:

ЭтоДокументация API для Rails Application Documentation.

Чтобы увидеть README_FOR_APP, я должен нажать README_FOR_APP в списке страниц слева.

Я смотрел Как переименовать или переместить Rails README_FOR_APP , но ОП утверждает, что он уже видит желаемое поведение.

Я использую рельсы 3.1.3.

1 Ответ

8 голосов
/ 23 января 2012

Во-первых, создайте новый файл rake (например, lib/tasks/documentation.rake) в вашем проекте. Затем переопределите грабли: 

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
...