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.

Answer 1

gem install mislav-hanna

Then just follow the steps in the readme:

http://github.com/mislav/hanna/blob/8eaeb062fae276b19eb86fa302e9ee446a06eef8/README.markdown

Answer 2

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

Answer 3

In your ruby source directory, run

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

Answer 4

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