[分享] 用 sdoc 製做可搜尋的 Ruby & Rails API
2012-01-20 16:47:07 +0800 由 yjchenx
在 Ruby on Rails 節點 中發起
最後由 chechaoyang 於2012-03-02 09:11:24 +0800回應
, 137次閱讀
Rails Searchable API Doc (http://railsapi.com/) 提供可搜尋的 Ruby & Rails API 文件，但有一陣子沒更新了。Rails 亦使用同樣的系統來製做其 API 文件，但沒提供下載的功能，就不能離線使用。在這裡簡單的介紹如何使用 sdoc (http://github.com/voloko/sdoc) 自己做一個，就可以離線使用，並隨時更新。
首先用 'gem install sdoc' 安裝 sdoc. 下載 Ruby 及 Rails 的原始碼。分別解開後在其目錄下執行
bash> cd ruby-1.9.3-p0
bash> sdoc -N ./ --op sdoc
這樣子就會在 sdoc 目錄下產生可搜尋的 API 文件，直接打開 sdoc/index.html 即可。如果要把分別製做的 sdoc 文件合併在一起，則可以用以下命令：
bash> sdoc-merge --title "Ruby v1.9.3, Rails v3.1.3" --op merged --name "Ruby, Rails" ruby-1.9.3-p0/sdoc rails3.1/sdoc
合併的 API 會在目錄 merged/ 中。
同步轉載 http://blog.berylliumwork.com/2012/01/sdoc-ruby-rails-api-use-sdoc-to-make.html
截至 2012-03-02 09:11:24 +0800，共收到 2 條回應
chechaoyang
1樓, 於2012-03-02 08:40:57 +0800回應
非常感謝你的分享！
chechaoyang
2樓, 於2012-03-02 09:11:24 +0800回應
補充下，我使用ruby 1.9.3制作ruby 1.9.3的文檔，會出現invalid byte sequence in US-ASCII錯誤，應該是ruby 1.9的編碼問題，使用RVM切換到ruby 1.8.7就一切正常了。