¿Puedo obtener mi README.textile en mi RDoc con el formato correcto?

Question

Me gusta usar textiles o de rebajas para escribir archivos Léame para mis proyectos, pero cuando genero la RDoc el archivo readme se interpreta como RDoc y se ve realmente horrible. ¿Hay una manera de hacer RDoc ejecute el archivo a través de RedCloth o BlueCloth en lugar de su propio formateador? Puede ser configurado para detectar automáticamente el formato del sufijo de archivo? (Por ejemplo README.textile se ejecute a través de RedCloth, pero README.mdown se ejecute a través de BlueCloth)

Answer 1

patio en lugar de directamente RDoc le dejará incluir textiles o de rebajas archivos siempre y cuando sus sufijos de archivo son razonables. A menudo utilizo algo como la siguiente tarea 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

Si aloja su proyecto en GitHub también se puede utilizar http://rdoc.info para construir automáticamente y publicar su rdocs utilizando Yard.

Answer 3

Me cuenta el código en 26819 fue precedido por "algo parecido", pero hay problemas me encontré con. Mis ediciones a la respuesta fueron rechazadas, por lo que aquí hay una versión fija (ediciones se comentan):

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