在本地访问 ruby 标准库文档答案

【问题标题】：accessing ruby standard library documentation locally在本地访问 ruby 标准库文档
【发布时间】：2023-04-04 01:20:02
【问题描述】：

我刚开始接触 Ruby - 我遇到一些麻烦的事情是 Intellisense / 代码完成，所以如果我没有它，我真的需要让 API 近在咫尺一直。我上周发现了：

gem server

这会启动一个服务器，让您可以查看所有已安装 gem 的文档。是否有与此等效的功能，可让您浏览标准库而不是 gem？

使用 Linux/Ruby 1.8.7。

【问题讨论】：

你经常离线编码吗？因为如果没有，文档总是在rubydoc.info/stdlib。
是的，我在通勤时经常离线编写代码，我在家时一直在使用 rubydoc，但在命令行中获取文档仍然很好

标签： ruby ri

【解决方案1】：

在您的终端中，您可以使用ri 打印文档的特定部分。（请注意，如果您使用 RVM 管理您的 ruby 安装，您可能需要运行 rvm docs generate 以避免收到“Nothing known about....”响应）

例如：

> ri Array#drop

会输出：

------------------------------------------------------------- Array#drop
     ary.drop(n)               => array
------------------------------------------------------------------------
     Drops first n elements from _ary_, and returns rest elements in an
     array.

        a = [1, 2, 3, 4, 5, 0]
        a.drop(3)             # => [4, 5, 0]

【讨论】：

我想我仍然缺少一些东西 - 这是我从你的 cmd 得到的（虽然我注意到 ri 也适用于其他东西）：mikey@mikey-netbook:~$ ri Array#在 [/var/lib/gems/1.8/specifications/json_pure-1.6.1.gemspec] 中删除无效的 gemspec：规范中的无效日期格式：“2011-09-18 00:00:00.000000000Z” 对数组一无所知#drop
这很酷，我认为 drop 可能是 1.9.2 的方法，ri 命令确实适用于其他方法。干杯！
不，drop 大约在 1.8.x 中。但很高兴听到它在其他方面起作用。
另外，如果您使用的是 RVM，您可能需要运行 rvm docs generate 以避免出现“Nothing known about...”错误。
我没有使用rvm，我应该如何在本地查看文档？

【解决方案2】：

几个选项：

Local, searchable Rails and Ruby docs（添加其他文档的选项，如 haml、rspec、rack 等，但不是最新的）
Create from source
ri
... and a million tools to generate snazzy docs from Ruby source，包括...
doc，它会生成本地可搜索的文档，无论您告诉它什么；我正在挖掘它

【讨论】：

第一个 (railsapi.com) 已过时，ri 非常基础（当您习惯通过 IDE 或 Web 浏览器进行文档编制时 - 首先您必须了解该类您想要打开文档，其次它并不总是有效 - 例如ri String 给出关于 String 的任何信息），最后一个（文档）不适用于 Ruby 2.0.0。
@SnowCrash 1 这就是我说的，2 就是它的本质——它是代码中的文档，如果你不生成文档，则没有什么可显示的，3 可以是的，但两年前 Ruby 2 并不重要。

【解决方案3】：

Devdocs 完成这项工作

它（也）离线工作
不限于 ruby 文档 ;)

从 github 克隆 repo：

git clone git@github.com:Thibaut/devdocs.git
cd devdocs

安装依赖：

gem install bundler
bundle install

下载文档：

thor docs:download --all

运行它：

rackup

默认情况下可以通过http://localhost:9292访问它

【讨论】：