1 post tagged “ruby”
I made a RDoc template named "Resh". Sample: http://safeeval.rubyforge.org/
Resh is abbreviation of reshape and pronounce as le'∫.
The default template uses frames and strong colors. It is bad. Frames are ancient technology for UI, and strong colors are bad for our eyes and the red color chafes us psychologically as reading the docs. So Resh uses clear HTML and light blue color like CPAN.
Resh ignores the options --inline-source and --main.
Resh always makes inline-sourced doc. The main index.html is automatically generated from README and the class/module definitions. That is just index.
The in-lined sources are expand by clicking the area which is discreet because it is almost white. Depending on your monitor or environment the area may be hard to find until you get used to it.
Download (Hosted by CodeRepos):
svn co http://svn.coderepos.org/share/lang/ruby/rdoc/generators/template/html/resh/
$ cat ~/.gemrc
rdoc: --template path-to/resh.rb --inline-source
$ sudo gem rdoc --all --no-ri --config-file ~/.gemrc
You can also use Resh for your gems documentations by setting the option of Rake::RDocTask in your Rakefile.
rdoc.template = "path-to/resh.rb"
More information exists on CodeRepos Wiki.
