How to create Ruby documentation using a different template?

Question

I want to generate Ruby documentation with hanna .

How to do it? Or where can I download it, if available at all?

Using

rdoc -o ~/doc --inline-source --line-numbers --format=html --template=hanna

gives me documents with missing methods. It does not appear to generate methods written in C.

+4

htanata Apr 01 '09 at 8:34

4 answers

In your ruby source directory, run

hanna -o --inline-source -line-numbers --format = html

+1

stainless Sep 28 '09 at 9:28

gem install mislav-hanna

Then just follow the steps in readme:

0

Matthewford Apr 08 '09 at 0:00

If you use rvm, this works:

 $ gem install hanna $ cd ~/.rvm/src/ruby-1.8.6-p383 $ hanna -o doc/api --inline-source --line-numbers --fmt=html $ open doc/api/index.html

0

pjb3 Apr 22 '10 at 0:17

htanata · Accepted Answer · 2009-04-20T02:57:11+0000

Turns out you just need to get the Ruby source code , extract it, and then run something like this in the source directory:

 rdoc -o <output path> --inline-source --line-numbers --format=html --template=hanna