问题描述
我想阅读 rb-gsl
gem 的一些文档。例如,rdoc file 用于 multimin 类。如何在浏览器中查看此文件并遵循文件中的链接(这些链接似乎是指同一存储库中的其他 rdoc 文件)。
解决方法
我知道至少有两个选项可以查看 gems 的 rdoc 文档:
- 使用在线文档 - 例如:https://rdoc.info/github/SciRuby/rb-gsl/
- 使用Yard
使用 Yard,您可以做很多事情,包括运行本地服务器以显示所有已安装 gem 的文档。
$ gem install yard
$ yard server --gems --port 3000
然后,访问 http://localhost:3000 以查看 gem 列表,每个 gem 都有完整的文档。