rubyソースコードをHTMLとしてRDOCに追加します
質問
RDOCにRubyコードファイルを含めるにはどうすればよいですか?
宝石の使用方法を文書化するrbファイルがあり、それをreadme.rdocやhistory.rdocなどのファイルの1つとして含めたいと思います。
ルビーソースコードをHTMLに変換する方法を既に考え出しました 構文ジェム しかし、RDOCを解析せずにファイルを含める方法を理解することはできません。
rdocにHTMLファイルを含めるように指示すると、リストされておらず、ファイル拡張子としてRDOCまたはTXTを使用して適切に表示されない場合に偽造する場合(ファイルは実際にはHTMLです)。
私はそれが信じられないほどugいものになる解決策を持っています。 RDOCのネイティブであるこれを行うためのより良い方法が必要ですが、私はそれを見ません。
これが私のrakefileに私が持っているものです:
# 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]
所属していません StackOverflow