我一直觉得 Ruby 社区最好的 API 文档，或者可以说我见过所有语言框架的 API 中最好的。查询方便，清晰。

我们都知道 Ruby 社区有 RDoc, Yardoc 两种工具可以基于源代码生成文档。

• RDoc 是 Ruby 自带的工具，排版和交互比较差，Ruby 官方文档似乎就是它做的
• Yardoc 要更好看一些，还有在线工具 http://rdoc.info/，但依然有些地方不是太好用，例如搜索，目录索引什么的

SDoc 另外一个选择

你可以用它轻松生成像 api.rubyonrails.org 那样的文档。

只需要 Gemfile 增加：

gem 'sdoc'
# 注意 Ruby 2.4 用
gem 'sdoc', '1.0.0.rc1'

然后 bundle install

修改 Rakefile

RDoc::Task.new do |rdoc|
  rdoc.rdoc_dir = 'public/rdoc'
  rdoc.generator = 'sdoc'
  rdoc.template = 'rails'
  rdoc.main = 'README.md'
  rdoc.rdoc_files.include("REAME.md", "API.md", "lib/", 'app/")
end

然后执行 rails rerdoc 就可以生成了，文档将会到 public/rdoc 目录。

SDoc 项目地址

https://github.com/zzak/sdoc

是的，Rails 的文档就是用它做的