生成Ruby的离线文档_Ruby_编程开发_程序员俱乐部

Ruby 2.0已经发布有一段时间了，Yeah! ，虽然官方提供了离线文档，但我不喜欢新版的rdoc样式，而且好像也有链接的错误。好在有其他的可替代的rdoc可选，比如sdoc和yardoc。

个人比较喜欢sdoc的风格，这里就用sdoc举例制作Ruby的离线文档。

首先到官网下载ruby源码，然后解压缩，如果电脑里还没有Ruby程序，可以用rbenv或rvm安装，或用下载的源码安装，方法都很简单，这里就不介绍了。

然后安装sdoc gem

class="bash">
gem install sdoc

生成ruby core文档

在终端里更改当前目录到已解压的ruby源码目录，执行

sdoc -o ruby-core *.c prelude.rb ChangeLog NEWS README README.EXT README.EXT.ja README.ja doc

经过一段时间就会在ruby-core目录中生成了core的离线文档

接下来在生成ruby stdlib文档

方法与上面的类似，只是需要的目录不同而已

sdoc -o ruby-stdlib lib/ ext/ prelude.rb ChangeLog NEWS README README.EXT README.EXT.ja README.ja doc

参数 -o 是指定的生成文档的输出目录，我生成的文档版本是ruby-2.0.0-p247，sdoc的版本是0.3.20，在编译时会在lib/rdoc/markdown目录中出错，可以用 -x markdown 参数排除，更多使用方法也可以使用 sdoc --help 查看。

如果使用yardoc也是类似的方法，或者看这篇文章