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使用极其不方便,建议还是去网站:
http://railsapi.com/下载或DIY所需API。
2、rdoc生成指定gem的api文档(非windows平台,非ruby1.8自行替换相关路径)
首先,你要先确定你的Windows机器上以前装过MS的【HTML Help Workshop】,如果安装的时候不改路径的话,
【C:\Program Files\HTML Help Workshop】文件夹就是它了。
没装不要紧,以下是下载链接:
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/htmlhelp/html/hwMicrosoftHTMLHelpDownloads.asp
这个是没装【HTML Help Workshop】,RDoc给出的下载链接,跳转之后是这个:
http://msdn.microsoft.com/en-us/library/ms669985
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
分享到:
相关推荐
更改了生成器(没有样式表,没有助手,没有 javascripts 而rails generate ) 补充发展的宝石:vendorer,撬,better_errors,binding_of_caller和quiet_assets 用于创建Vendorfile 的 vendorer init 和初始提交...
简单的rails gem,用于基本角色授权,并且在rails上使用ruby。 变更日志 请阅读CHANGELOG.rdoc文件。 安装 gem install easy_roles 或者可以将其安装为Rails插件。 script/plugin install git://github....
信息RDoc文档源代码更多信息,已知限制和操作方法获得帮助如有任何疑问,请向社区寻求帮助。 请不要在问题跟踪器上发布使用问题。 请报告错误,但请先阅读Wiki中的“获得帮助”部分。安装安装最新版本: $ gem ...
在Ruby on Rails,Sinatra和Nanoc上进行了测试,但它也应该与其他产品一起使用。 Highcharts并非免费用于商业用途,因此请确保您具有使用Highcharts的有效许可证。 信息 RDoc文档 源代码 更多信息,已知限制和操作...
信息可在RubyDoc.info上找到RDoc文档GitHub上可找到源代码在Wiki上可以找到更多信息,已知限制和操作方法获得帮助如果您有任何疑问,请向Stack Overflow社区寻求帮助。 请不要在问题跟踪器上发布使用问题。 l
DocToDash将文档文件(Rdoc Darkfish / YARD)转换为类和方法文档集,然后可以将其加载到文档集查看程序:Dash。 安装 将此行添加到您的应用程序的Gemfile中: gem 'doc_to_dash' 然后执行: $ bundle 或将其...
如果您需要在本地生成RDoc文件,请检出存储库,只需在项目文件夹中调用rake rdoc 。在线演示您可以尝试通过简单导航。 该在线演示的源代码。反馈和问题不要犹豫,参加该。贡献分叉,修复,然后发送拉取请求。 要...
这些类的完整文档可以在这里找到: 安装要使用gem,您需要将其添加到Gemfile中最新版本 gem 'evnt' , git : 'https://github.com/ideonetwork/evnt' 旧版 gem 'evnt'发展RDoc文档要更新rdoc文档,请运行: rdoc --...
在此 README.rdoc 所在的目录中执行 bundle 命令。 数据库setup¶ ↑ 在 MySQL 或 PostgreSQL 上创建专用于此系统的数据库。 根据数据库的连接参数修改config/database.yml。 运行 RAILS_ENV = production bin / ...
此任务将安装所有缺少的依赖项,运行测试,并生成RDoc。 现在,您可以创建并提交补丁了。 在上创建一个问题或请求,该请求链接到上的分支或补丁的要旨。 执照 (麻省理工学院执照) 版权所有(c)2013 Mike Moore ...
这个想法来自于和他的 class_logger。 我只是增加了一些灵活性,让它在 Rails 之外工作。安装gem 安装 class_logger选项ClassLogger 支持一系列直接传递给 Logger 的选项。 这些选项中的大多数应该是有意义的,但是...
RDoc 文档 源代码 更多信息、已知限制和操作方法 获得帮助 请在上报告错误,但请先阅读 wiki 中的“获得帮助”部分。 安装 在 Rails 中,对于最新的稳定版本,请将其添加到您的 Gemfile 中: gem 'admin_bits' ...
在Windows下,如果使用了mysql 5.1,不但在安装mysql.gem时候会报ri和rdoc的错误,而且在执行 rake db:migrate时候也会报错: 这是由于mysql5.1里面所带的libmySQL.dll和rails不兼容(至少在2.3.5还是如此)。...
gem install unicorn --no-ri --no-rdoc curl https://raw.github.com/jaustinhughey/unicorn-status/master/unicorn_status.rb > ~/unicorn_status.rb 错误/贡献:欢迎提取请求。 增强功能,错误修复等等,都很好...
环境PostgreSQL 9.4 MongoDB 3.0.10 Redis 3.2.6 Ruby 2.3.1(另请参见 ) 节点6.10.3安装后端cd backendecho " gem: --no-ri --no-rdoc " > ~ /.gemrcbundle install --without production -j5 --retry 10cp env-...
MongoMapper Mongo的Ruby对象映射器。 ...安装¶↑$ gem install mongo_mapper文档兼容性)此外,还对MongoMapper进行了测试:Rails 3.2.x Rails 4.0.x Contributing&Development¶↑$ git clone ...
RDOC 安装Mongoid Magic Counter Cache至少需要ruby 1.9.3Ruby$ [sudo] gem install mongoid_magic_counter_cache宝石文件gem 'mongoid_magic_counter_cache'用法首先,将一个字段添加到文档中,您将从中访问计数器...