ruby-on-rails - 如何重命名或移动 Rails 的 README_FOR_APP

Question

当我在我的 Rails 应用程序根目录中运行 rake doc:app 时，API 文档是使用 /doc/README_FOR_APP 作为主页生成的。我想向该文件添加 .rdoc 扩展名，以便它在 GitHub 上正确呈现。更好的是，我想将它移动到应用程序根目录 (/README.rdoc)。有没有办法通过修改包含的 rake/rdoctask 任务在我的 Rakefile 中执行此操作？是否有某个地方可以查找可以修改的主页文件的名称？还是我必须编写一个新的 Rake 任务？

额外的问题:Rails 应用程序的两个单独文件 /README 和 /doc/README_FOR_APP 背后的逻辑是什么？为什么不只有一个？

Answer 1

Rails rdoc 任务在 <rails gem folder>/lib/tasks/documentation.rake 中

做你想做的事，接受 :app 任务并改变它，把它放在你应用程序的/lib/tasks 中的 .rake 文件中

#clear the doc:app task et al
Rake::Task["doc:app"].clear
Rake::Task["doc/app"].clear
Rake::Task["doc/app/index.html"].clear

namespace :doc do
  desc "Generate documentation for the application. Set custom template with TEMPLATE=/path/to/rdoc/template.rb or title with TITLE=\"Custom Title\""
  Rake::RDocTask.new("app") { |rdoc|
    rdoc.rdoc_dir = 'doc/app'
    rdoc.template = ENV['template'] if ENV['template']
    rdoc.title    = ENV['title'] || "Rails Application Documentation"
    rdoc.options << '--line-numbers' << '--inline-source'
    rdoc.options << '--charset' << 'utf-8'
    rdoc.rdoc_files.include('app/**/*.rb')
    rdoc.rdoc_files.include('lib/**/*.rb')
    rdoc.rdoc_files.include('README')
    rdoc.main = 'README'
  }
end

我不确定这是否正是它，但尝试一下并查看 rdoc task docs了解更多信息。