ruby - README.textile を適切なフォーマットで RDoc に入れることはできますか?

Question

プロジェクトの readme ファイルを作成するために Textile または Markdown を使用するのが好きですが、RDoc を生成すると、readme ファイルが RDoc として解釈され、非常に見栄えが悪くなります。独自のフォーマッターではなく、RedCloth または BlueCloth を介して RDoc でファイルを実行する方法はありますか? ファイルのサフィックスからフォーマットを自動検出するように構成できますか? (例: README.textile は RedCloth を介して実行されますが、README.mdown は BlueCloth を介して実行されます)

Answer 1

RDoc の代わりにYARDを直接使用すると、ファイル サフィックスが適切である限り、Textile または Markdown ファイルを含めることができます。私はよく次の Rake タスクのようなものを使用します。

desc "Generate RDoc"
task :doc => ['doc:generate']

namespace :doc do
  project_root = File.expand_path(File.join(File.dirname(__FILE__), '..'))
  doc_destination = File.join(project_root, 'doc', 'rdoc')

  begin
    require 'yard'
    require 'yard/rake/yardoc_task'

    YARD::Rake::YardocTask.new(:generate) do |yt|
      yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb')) + 
                   [ File.join(project_root, 'README.md') ]
      yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
    end
  rescue LoadError
    desc "Generate YARD Documentation"
    task :generate do
      abort "Please install the YARD gem to generate rdoc."
    end
  end

  desc "Remove generated documenation"
  task :clean do
    rm_r doc_dir if File.exists?(doc_destination)
  end

end

Answer 2

プロジェクトを github でホストする場合、http://rdoc.info を使用して、YARD を使用して rdoc を自動的にビルドおよび公開することもできます。

Answer 3

26819のコードの前に「何か」があったことは認識していますが、遭遇した問題があります。回答に対する私の編集は拒否されたので、ここに修正バージョンがあります（編集はコメントされています）：

desc "Generate RDoc"
task :doc => ['doc:generate']

namespace :doc do

  # edit: typically (for gems, at least), Rakefile is in the root, so ".", not ".."
  project_root = File.expand_path(File.join(File.dirname(__FILE__), '.'))
  doc_destination = File.join(project_root, 'doc', 'rdoc')

  begin
    require 'yard'
    require 'yard/rake/yardoc_task'

    YARD::Rake::YardocTask.new(:generate) do |yt|
      # edit: README.md is not a ruby source file - see
      # https://stackoverflow.com/questions/7907698/yard-0-7-3-fails-to-build-my-readme-in-both-markdown-and-textile
      # remove README.md from yt.files
      yt.files   = Dir.glob(File.join(project_root, 'lib', '**', '*.rb'))
      yt.options = ['--output-dir', doc_destination, '--readme', 'README.md']
    end
  rescue LoadError
    desc "Generate YARD Documentation"
    task :generate do
      abort "Please install the YARD gem to generate rdoc."
    end
  end

  desc "Remove generated documenation"
  task :clean do
    #edit: doc_dir was undefined; replaced by doc_destination
    rm_r doc_destination if File.exists?(doc_destination)
  end

end