Я могу получить свой README.textile в мой RDoc с надлежащим форматированием?

Question

Я могу получить свой README.textile в мой RDoc с надлежащим форматированием?

Мне нравится использовать Ткань или Скидку с цены для записи readme файлов для моих проектов, но когда я генерирую RDoc, readme файл интерпретируется как RDoc и выглядит действительно ужасным. Существует ли способ заставить RDoc петлять через RedCloth или BlueCloth вместо его собственного средства форматирования? Это может быть настроено для автоматического обнаружения форматирования от суффикса файла? (например, README.textile пробегается RedCloth, но README.mdown пробегается BlueCloth),

5

ruby rdoc textile

задан Theo 26 January 2010 в 09:20

1 ответ

Другие вопросы по тегам:

ruby rdoc textile

Похожие вопросы:

score 7 · Accepted Answer

Использование двор Вместо RDOC напрямую даст вам включить файлы текстильных или разметки до тех пор, пока их файловые суффиксы являются разумными. Я часто использую что-то вроде следующую задачу грабля:

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