如何重命名或移动Rails的README_FOR_APP

Question

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

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

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 任务文档以获取更多信息。