宝石的 ruby 文档在哪里？

Question

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

如何在 ruby 中执行此操作？无论我使用 pry 还是 irb 我都找不到太多有用的文档。

我正在尝试使用 Faraday，但输入 ri Faraday 没有提供任何文档。输入 ri String 会给出 String 的文档，但是像 faraday 这样的宝石不会产生任何文档。

我做错了什么？

Answer 1

查看 pry 的 pry-doc 扩展。

Answer 2

如果您使用 gem install --ri faraday 安装 gem，那么将为您生成 ri 文档。

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

即使是这种情况，您也可以通过在安装 gem

时添加该参数来根据具体情况覆盖它

Answer 3

如果您想阅读该文档，您可以运行

gem server

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

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

gem环境

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，但不存储文档（这使得捆绑器比 gem 安装快得多）

宝石的 ruby 文档在哪里？

Where is the ruby documentation for gems?

ruby

faraday