Добавить исходный код Ruby как HTML в RDOC

Question

Как я могу включить файл кода Ruby, как есть, в RDOC?

У меня есть файл example.rb, который документирует, как использовать свой драгоценный камень, и я хотел бы включить это как один из файлов, таких как readme.rdoc и history.rdoc.

Я уже выяснил, как преобразовать исходный код Ruby в HTML с помощью Синтаксический драгоценный камень Но я не могу понять, как сделать RDOC включать файл без разбора его.

Когда я скажу RDOC, чтобы включить файл HTML, он не указан, и если я подделаю его, используя RDOC или TXT в качестве расширения файла, он не отображается должным образом (файл все еще на самом деле HTML).

У меня есть решение, которое работает, это просто невероятно некрасиво. Должен быть лучшим способом сделать это, который является родным для RDOC, но я этого не вижу.

Вот что у меня в моем рикефиле:

# Build rdocs
require 'rake/rdoctask'
require 'syntax/convertors/html'
rdoc_dir = 'rdoc'
# This is rdoc1 but it doesn't work unless you DON'T wrap it in a task
# Generate html files from example ruby files
convertor = Syntax::Convertors::HTML.for_syntax "ruby"
replacement_key = "REPLACE_THIS_TEXT_WITH_PROPER_HTML"
# Create dummy files
Dir.glob('examples/*.rb').each do |file|
  File.open("#{file}.txt", "w") do |dummy_file|
    dummy_file.write(replacement_key)
  end
end

# Call the rdoc task
Rake::RDocTask.new(:rdoc2) do |rdoc|
  rdoc.rdoc_dir = rdoc_dir
  rdoc.title = "pickled_optparse #{version}"
  rdoc.rdoc_files.include('README*')
  rdoc.rdoc_files.include('HISTORY*')
  rdoc.rdoc_files.include('examples/*.txt')
  rdoc.rdoc_files.include('lib/**/*.rb')
end

task :rdoc3 do
  # Now use a hammer to replace the dummy text with the
  # html we want to use in our ruby example code file.
  html_header = File.read('rake_reqs/html_header.html')
  Dir.glob('examples/*.rb').each do |file|
    html_ruby = convertor.convert(File.read(file))
    rdoc_file = "#{rdoc_dir}/examples/#{File.basename(file,".rb")}_rb_txt.html"
    fixed_html = File.read(rdoc_file).gsub!(replacement_key, "#{html_header}#{html_ruby}")
    File.open(rdoc_file, "w") {|f| f.write(fixed_html)}
    File.delete("#{file}.txt")
  end
end

task :rdoc => [:rdoc2, :rdoc3]

Answer 1

Извините, я не могу дать вам актуальный ответ, но я смотрю на SDOC. себя. Вы можете установить драгоценность от Ruby Gems.