宝石的红宝石文档在哪里？ [关闭]答案

【问题标题】：Where is the ruby documentation for gems? [closed]宝石的红宝石文档在哪里？ [关闭]
【发布时间】：2015-07-28 21:41:05
【问题描述】：

在像 ipython 这样的交互式控制台中的 python 中，我可以输入 ?并获取几乎所有库或函数的文档。

我如何在红宝石中做到这一点？无论我使用的是 pry 还是 irb，我都找不到太多有用的文档。

我正在尝试使用 Faraday，但输入 ri Faraday 并没有提供任何文档。键入 ri String 会提供 String 的文档，但像 faraday 这样的 gem 不会生成任何文档。

我做错了什么？

【问题讨论】：

有点困惑，关于安装 ruby 文档的问题对于编程站点来说是题外话......我不是要任何人推荐任何东西，我是在问为什么我的 ruby 文档看起来不工作，感谢下面的 cmets，我能够解决我的问题......

标签： ruby faraday

【解决方案1】：

如果您使用 gem install --ri faraday 安装 gem，则会为您生成 ri 文档。

这应该是默认设置，但由于 Ri doc 生成可能需要一段时间，所以很多人通过在 ~/.gemrc 中添加一行来禁用它，说 gem: --no-ri --no-rdoc（提供这些选项作为 gem 命令的默认设置）。

即使是这种情况，您也可以通过在安装 gem 时添加该参数来逐个覆盖它

【讨论】：

这是问题所在，gem: --no-ri --no-rdoc 在我的~/.gemrc中

【解决方案2】：

查看pry-doc 的扩展名pry。

【讨论】：

【解决方案3】：

如果您想阅读该文档，您将能够运行

gem server

这将在您的主机上的 8808 端口上创建一个 Web 服务，您将能够通过浏览器访问它。

如果您想查看该信息的位置，请运行 gem env，您将看到 GEM PATHS 部分的所有路径。

宝石环境

RubyGems Environment:
.......2.2.2/etc
  - RUBYGEMS PLATFORMS:
    .....
  - GEM PATHS:
     - /home/hbranciforte/.rvm/gems/ruby-2.2.2
     - /home/hbranciforte/.rvm/gems/ruby-2.2.2@global
  - GEM CONFIGURATION:
     .....
  - REMOTE SOURCES:
     - https://rubygems.org/
  - SHELL PATH:
.....

如果您查看 GEM PATHS，您会发现一个名为 doc 的文件夹。

hbranciforte@hbranciforte-MacBookPro:gems/ruby-2.2.2 $ cd /home/hbranciforte/.rvm/gems/ruby-2.2.2
hbranciforte@hbranciforte-MacBookPro:gems/ruby-2.2.2 $ ls
bin  build_info  cache  doc  environment  extensions  gems  specifications  wrappers

有时（几乎我经常这样做）使用 bundle --path bundle/vendor 运行您的项目

这会创建一个文件夹 bundle/vendor，它将存储您的 gem，但不存储 doc（这使得 bundler 比 gem install 快得多）

【讨论】：