Question

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

目前，内容为：

这是Rails应用程序文档的API文档。

要查看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

如何使README_FOR_APP的内容出现在doc / app / index.html中

1 个答案: