2008年10月23日星期四

How To Generate Local RDocs

最近 http://www.ruby-doc.org/core/ 无法访问了,而 ri 用起来始终不习惯。偶然看到了个生成 Local RDocs 的方法。

http://www.mindsifter.com/2008/1/8/generate-local-ruby-core-rdocs
http://weblog.jamisbuck.org/2005/4/8/rdoc-template

Download the template here
To use it, copy it into the “rdoc/generators/template/html” directory of your Ruby installation.
Then:

rdoc --template=jamis --op <some output dir>


可能由于我机器上 rubygem 版本的原因,这个模板用不了,不过可以用自带的模板

rdoc --template=html --op <some output dir>


注:执行这个命令时,要先转到 ruby 源代码的目录,默认是生成该目录下所有文件的 rdoc。
也可以指定文件:

rdoc --template=html --op <some output dir> array.c

没有评论: