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

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

目前，内容为:



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

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

我正在使用 rails 3.1.3。

最佳答案

首先，在您的项目中创建一个新的 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

关于ruby-on-rails - 如何让 README_FOR_APP 的内容出现在 doc/app/index.html，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/8415676/