如何安装Ruby ri文档?
我最近在Windows 7上安装了Ruby 1.9.1,显然它没有附带标准的ri文档。 所以当我做’ri Array’时,我得到:
C:\>ri Array Nothing known about Array
有没有办法安装这个文档,以便上述工作?
似乎你有RubyInstaller项目分发的安装程序Ruby 1.9.1。
您可以使用安装程序附带的Windows帮助文件(CHM)而不是ri文档。
RI文档的问题在于某些版本的RDoc在生成它时遇到问题,并且还生成了超过10,000个文件,这大大减慢了安装程序的速度。
如果其他平台上的人需要安装他们的ri文档(就像我一样)。 本文给出了原因和方法:
命令是:
gem rdoc --all --ri --no-rdoc
如果你使用rvm,你应该rvm docs generate
(或者只是rvm docs generate-ri
)
关于rvm和ri,请参阅此信息(2011年8月)
所提出的解决方案都不适合我。 最后我找到的解决方案非常简单,所以我会把它放在这里。 (我在win7 x64上运行ruby 2.2.4,如果相关的话)
(船长明显提醒:必须安装ruby并在你的路径中)
– 打开cmd
-$ gem install rdoc-data -$ rdoc-data --install
你就定了! 通过运行测试它是否有效:
-$ ri Array
它应该为你提供课堂上所有可爱的文档!
希望这可以帮助!
PS。 我只是注意到这是Luis Lavena在评论中提出的解决方案,但他的评论对我来说并不清楚,所以我继续搜索。 基本上这是相同的解决方案,但更清楚地解释,这样就不会发生在其他任何人身上:)
干杯!
RVM不会自动生成和安装每个Ruby的ri / rdoc文档。 您可以使用以下命令生成:rvm docs generate
所有Ruby Docs都在http://www.ruby-doc.org
因此arrays文档位于:
http://ruby-doc.org/core/classes/Array.html
从来没有尝试过在Windows上,但是因为它说没有知道关于X它不是没有安装它只是没有得到任何东西。
尝试安装一个gem,然后你可以ri GEM_CLASS
因为它应该提供防御,应该让我们看看它是否缺少文档或ri没有找到正确的位置
Ruby Installer 2。4。1。2(2017年)的情况基本相同。 如果我运行ri Array
,它会显示Array < Object
ri Array
显示其他内容。 如果我运行ri "Array#each"
,我会得到熟悉的“Nothing known ...”消息。 简而言之,缺少Ruby核心和标准库的ri格式文档。
以下是我获取core / stdlib ri文档的副本。 当然,必须在此之前安装Ruby。
- 从他们的Github发布页面获取与我的版本最匹配的ruby源代码。
- 将.zip或.tar.gz存档解压缩到某个文件夹
- 打开cmd.exe / Powershell,
cd
到该文件夹并运行rdoc --all --ri
- 此命令以递归方式解析当前目录中的.c文件,.rb文件和一些其他文件类型,并生成
~/.rdoc
目录的ri文档。 - 使用i7-3520M处理器在我的笔记本电脑上花了大约5分钟完成,没有任何错误。
- 此命令以递归方式解析当前目录中的.c文件,.rb文件和一些其他文件类型,并生成
- 删除存档和包含源代码的目录,因为我们不再需要它们了。
现在,如果您尝试运行ri Array
或ri "Array#each"
您将获得所有荣耀的文档。
TL;博士
在包含与安装版本相同的ruby版本的源代码的目录上运行rdoc --all --ri
。
附录Z:对其他答案的评论
-
rvm docs generate-ri
可以工作,但你必须在Windows上使用Cygwin或Ubuntu(如果在Windows 10上)才能使用rvm
。 -
gem rdoc --all --ri --no-rdoc
为你的所有gem安装ri文档。 它不会安装core / stdlib文档。 -
gem install rdoc-data
后跟rdoc-data --install
仅适用于最高2.3.0的Ruby版本。