ruby-on-rails - 如何使 README_FOR_APP 的内容出现在 doc/app/index.html

Question

我希望 doc/README_FOR_APP 的内容出现在 doc/app/index.html 中，当我执行 rake doc:app.

目前，内容为:

This is the API documentation for Rails Application Documentation.

要查看README_FOR_APP，我必须点击左侧页面列表中的README_FOR_APP。

我看过 How to Rename or Move Rails's README_FOR_APP但 OP 断言他已经看到了我想要的行为。

我正在使用 Rails 3.1.3。

Answer 1

首先，在您的项目中创建一个新的 rake 文件(例如 lib/tasks/documentation.rake)。然后重新定义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