如何使用不同的模板生成Ruby文档?

时间:2009-04-01 08:34:18

标签: ruby documentation-generation rdoc

我想使用Ruby documentation模板生成hanna

怎么做?或者,如果可以的话,我可以在哪里下载?

使用

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

给了我缺少方法的文档。看起来它不会生成用C语言编写的方法。

4 个答案:

答案 0 :(得分:1)

在ruby源目录中,运行

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

答案 1 :(得分:0)

gem install mislav-hanna

然后按照自述文件中的步骤进行操作:

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

答案 2 :(得分:0)

如果您使用的是rvm,则可以:

$ 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

答案 3 :(得分:-1)

原来你只需要获取Ruby source code,将其解压缩,然后在源目录中运行如下:

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