在 ruby gem 中查看 rdoc 文件

Question

我想阅读 multimin class 的 rb-gsl gem. For example the rdoc file 的一些文档。如何在浏览器中查看此文件并点击文件中的链接（这些链接似乎引用同一存储库中的其他 rdoc 文件）。

Answer 1

我知道至少有两个选项可以查看 gems 的 rdoc 文档：

1. 使用联机文档 - 例如：https://rdoc.info/github/SciRuby/rb-gsl/
2. 使用Yard

使用 Yard，您可以做很多事情，包括 运行 一个本地服务器来显示所有已安装的 gem 的文档。

$ gem install yard
$ yard server --gems --port 3000

然后，访问 http://localhost:3000 查看 gem 列表，每个都有完整的文档。