Hi
I have some issues using Rake for the creation of code documentation.
I’ve done:
$ rvm install 1.9.2
$ rvm docs generate
$ gem install rdoc
$ gem list
*** LOCAL GEMS ***
rake (0.8.7)
rdoc (3.5.3)
I’ve created the following task in my Rakefile:
Rake::RDocTask.new { |rdoc|
rdoc.rdoc_dir = ‘doc’
rdoc.title = ‘CAN Emulation’
rdoc.main = ‘README’
rdoc.options << ‘–line-numbers’ << ‘–inline-source’
rdoc.options << ‘–charset’ << ‘utf-8’
rdoc.options << ‘-f’ << ‘darkfish’
rdoc.rdoc_files.include('README')
rdoc.rdoc_files.include('lib/**/*.rb')
}
When I type rake rdoc then the documentation is generated. However, the
interface is a little broken.
The icons left of the files, namespaces, classes, etc. are gone. (see
attachment: rake.jpg). This is not sp bad, but when you move your mouse
over a function, then this message is displayed: “click to toggle
source”. If you click on it, nothing happens.
When I test the same configuration with rdoc
$ rdoc --title ‘CAN Emulator’ -m README --line-numbers --inline-source
–charset utf-8 README lib/
then everything works fine (attachment rdoc1.jpg). Even the “click to
toggle source” action works (attachment rdoc2.jpg).
Am I missing something??? Why does that happen?
BTW: do we have here some kind of code-tags for ruby/bash code?
Thanks