I'm using Rake to generate RDoc documentation for my project, but I really hate the gray-on-gray style that Darkfish seems to generate. I'm happy with everything else, I'd just like to make the color scheme a little more readable.
Here's my rake task:
Rake::RDocTask.new do |rd|
rd.main = "README.rdoc"
rd.title = "My Title"
rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
rd.options = ['--main', 'README.rdoc']
end
I've tried adding '--style', 'doc/rdoc.css'
to the rd.options
above, but it complains that --style
is an unknown option and ignores it. I can't seem to find any documentation on how to customize templates or css etc; do I just have to put up with what Darkfish thinks looks good?
Darkfish has template support with --template 'your_template_name'; which will need to be set up as a an rdoc plugin gem, i believe.
This might help as well: http://fossplanet.com/f14/making-rdoc-template-gem-26986/
An RDoc plugin gem meaning a gem with a directory structure like:
./lib/rdoc/generator/template/#{your template name and files copied from rdoc-2.blah/lib/rdoc/generator/template/darkfish}
and
./rdoc/generate.rb
prepending the above template directory to the $LOAD_PATH. ($LOAD_PATH.unshift(File.expand_path(File.join(Dir.pwd,'..','lib', "#{..... and so on}"
)