【转】如何生成Rails和指定gem的rdoc

最新推荐文章于 2025-07-20 11:57:20 发布

原创最新推荐文章于 2025-07-20 11:57:20 发布 · 195 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#Rails #Ruby #ASP #Microsoft #HTML

Ruby on Rails 专栏收录该内容

13 篇文章

订阅专栏

本文介绍如何使用Rails和RDoc生成本地API文档，包括Rails文档的冻结与访问方法，以及如何为特定Gem如devise生成CHM格式的API文档。此外还提供了生成文档所需的HTML Help Workshop软件的下载链接。

1、生成Rails的rdoc


rails doc_app   
cd doc_app   
rake rails:freeze:gems   
rake doc:rails

成功后会在doc_app的doc目录下生成一个api目录，这里就是当前安装的rails相关组件的全部文档啦。

把这个目录复制到固定目录，把目录下的【index.html】“发送到桌面快捷方式”或者直接打开，然后添加收藏夹，以后便可以随时访问了，至于doc_app，删除即可。

另：
第三步换成


rake rails:freeze:edge

可以制作最新的rails文档。

注：此法生成的API使用极其不方便，建议还是去网站：
[url]http://railsapi.com/[/url]下载或DIY所需API。

2、rdoc生成指定gem的api文档(非windows平台，非ruby1.8自行替换相关路径)

首先，你要先确定你的Windows机器上以前装过MS的【HTML Help Workshop】，如果安装的时候不改路径的话，
【C:\Program Files\HTML Help Workshop】文件夹就是它了。
没装不要紧，以下是下载链接:
[url]http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp[/url]
这个是没装【HTML Help Workshop】，RDoc给出的下载链接，跳转之后是这个：

[url]http://msdn.microsoft.com/en-us/library/ms669985[/url]

3、装好这东西之后，就是运行命令生成.chm了。
这里以devise1.0.8为例：

(1)进到gem目录：
【C:\Ruby\lib\ruby\gems\1.8\gems】，就是gem包devise1.0.8的上一级目录。

(2)运行命令行：


rdoc -f chm [-n file_name ] -o chm_folder gems_folder_name

-f 是生成的文档格式, 支持chm、html、ri、xml
-n 可选参数，给要生成的chm指定名字
-o 是指定一个目录，chm_folder是要生成的chm的存放目录
gems_folder_name是目标gems所在的目录
如：


rdoc -f chm -n devise -o devise-chm devise-1.0.8

运行之后，gem【C:\Ruby\lib\ruby\gems\1.8\gems\devise1.0.8】的chm版本的rdoc就是以下目录：
【C:\Ruby\lib\ruby\gems\1.8\gems\devise-chm】中的文件【devise.chm】

4、另外，会意外地发现，html版本的rdoc也在同一样文件夹下面了。应该是先生成的html，再将html组合成chm的吧。

建议把常用，又不熟悉的gem单独搞个chm文件，用到的时候去翻翻，查查就OK了。

5、再补充下哈。


rdoc -f chm [-n file_name ] -o chm_folder gems_folder_name

中的gems_folder_name可以是多个gem文件夹，它们之间用空格相隔开，当然。版本号是必须的，不然会找不到目标文件夹的。如：


rdoc -f chm -n devise -o devise-chm devise-1.0.8 warden-0.10.7