How to generate Ruby documentation using different template?

Question

I want to generate the Ruby documentation with hanna template.

How to do that? Or where can I download it if it's available at all?

Using

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

gives me docs with missing methods. It seems like it doesn't generate methods written in C.

score 1 · Answer 1 · answered Sep 28 '09 at 09:28

1

In your ruby source directory, run

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

answered Sep 28 '09 at 09:28

stainless

This worked for me. Specifically, `cd ruby-1.8.7-p248 ; hanna -o hannadoc --inline-source --line-numbers --fmt=html ; open hannadoc/index.html`. – Jonathan Julian Apr 21 '10 at 16:08

score 0 · Answer 2 · answered Apr 22 '10 at 00:17

0

If you are using 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

answered Apr 22 '10 at 00:17

pjb3

score 0 · Answer 3 · answered Apr 08 '09 at 00:00

0

gem install mislav-hanna

Then just follow the steps in the readme:

answered Apr 08 '09 at 00:00

MatthewFord

score -1 · Accepted Answer · answered Apr 20 '09 at 02:57

-1

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

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

answered Apr 20 '09 at 02:57

htanata

4 Answers4