Posso colocar meu readme.textil no meu rdoc com formatação adequada?

Question

Eu gosto de usar têxteis ou markdown para escrever arquivos ReadMe para meus projetos, mas quando eu gero o RDOC, o arquivo ReadMe é interpretado como RDOC e parece realmente horrível. Existe uma maneira de fazer com que o RDOC execute o arquivo através do RedCloth ou Bluecloth em vez de seu próprio formatador? Pode ser configurado para automaticamente a formatação do sufixo do arquivo? (por exemplo, readme.textile é executado pelo RedCloth, mas o readme.mdown é executado pelo Bluecloth)

Answer 1

Usando JARDIM Em vez de o RDOC diretamente permitirá que você inclua arquivos têxteis ou de marcação, desde que seus sufixos de arquivo sejam razoáveis. Costumo usar algo como a seguinte tarefa de 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

Se você hospedar seu projeto no github, você também pode usar http://rdoc.info Para construir e publicar automaticamente seus rdocs usando o quintal.

Answer 3

Eu percebo o código em 26819 foi precedido por "algo como", mas há problemas que encontrei. Minhas edições da resposta foram rejeitadas, então aqui está uma versão fixa (as edições são comentadas):

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