将Ruby源代码作为HTML添加到RDOC

Question

如何将Ruby代码文件（如RDOC）包含在RDOC中？

我有一个示例.rb文件，该文件记录了如何使用我的宝石，我想将其包括在readme.rdoc和history.rdoc等文件之一中。

我已经弄清楚了如何使用Ruby源代码将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 我。您可以安装 宝石 来自红宝石宝石。