ruby - ページを RDoc に追加するには?

Question

Noob は、私の RDoc ドキュメントにページを追加するという簡単なタスクを理解しようとしています。ページを表示するrake doc:appと、「ページ」というサイドバーが表示され、README_FOR_APP がリストされます。「ページ」の下に表示される「チートシート」という名前のページを作成するだけです。ドキュメント ページを作成し、RDoc に新しいページを含めるように指示するにはどうすればよいですか?

Answer 1

IMO 少し複雑です。私が使用した参考文献は次のとおりです。

• http://rake.rubyforge.org/classes/Rake/RDocTask.html
• Rails の README_FOR_APP の名前を変更または移動する方法

一言で言えばバージョン:

Railsライブラリディレクトリから「アプリ」タスクを取得します。たとえば、次を使用してテストしました。

~/.rvm/gems/ruby-1.9.2-p0@foo/gems/railties-3.0.9/lib/rails/tasks/documentation.rake

必要な部分は（おおよそ）次のようになります。

namespace :doc do
  def gem_path(gem_name)
    path = $LOAD_PATH.grep(/#{gem_name}[\w.-]*\/lib$/).first
    yield File.dirname(path) if path
  end

  RDocTaskWithoutDescriptions.new("app2") { |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('doc/*_FOR_APP') # Modified this line
    rdoc.rdoc_files.include('app/**/*.rb')
    rdoc.rdoc_files.include('lib/**/*.rb')
  }
end

これをアプリのlib/tasksディレクトリにある.rakeファイルに入れます (例: doc2.rake.

元の名前を保持したい場合は、タスク名を更新します (例: "app2".

文字列をより広いパターンに更新する"doc/README_FOR_APP"か、処理する新しいファイルを追加してください。

作成doc/Cheatsheet_FOR_APPすると、新しいrake doc:app2タスクがそれを取得します。