如何在GitHub中爲項目創建API文檔？

我有幾個在GitHub中託管的ruby和rails項目。如何在GitHub中爲項目創建API文檔？

我想知道如何自動創建API文檔？

例子：

http://rake.rubyforge.org/

http://rspec.rubyforge.org/rspec/1.3.0/

是否有教程創建Ruby的這個API文檔？

來源

2010-08-20 never_had_a_name

這兩個示例鏈接都已死亡。你可以添加一個截圖或者經過時間考驗的東西嗎？ – Mogsdad 2018-01-17 17:43:32

這兩個示例均使用RDoc生成。第一個是標準RDoc模板，第二個是使用Hanna生成的。

您可以使用RDoc命令行工具或創建Rake任務輕鬆生成文檔。

begin 
    require "hanna/rdoctask" 
rescue LoadError 
    require "rake/rdoctask" 
end 

# Generate documentation 
Rake::RDocTask.new do |rd| 
    rd.main = "README.rdoc" 
    rd.rdoc_files.include("*.rdoc", "lib/**/*.rb") 
    rd.rdoc_dir = "rdoc" 
end

查看Rakefile瞭解更多詳情。

來源

2010-08-20 09:14:00

有沒有辦法將生成的文檔自動上傳到rubyforge？ – 2010-08-20 14:32:04

是的，有。許多圖書館如Echoe e Jeweler提供了一個rake任務來將內容上傳到RubyForge。否則，只需使用rsync命令即可。這正是我在我的庫中所做的（請參閱Rakefile）。 – 2010-08-20 19:32:23

示例鏈接已死亡。 – Mogsdad 2018-01-17 17:43:27

http://rdoc.info ca幫助您直接從您的github存儲庫創建文檔，請轉至http://rdoc.info/projects/new以添加您的項目。

來源

2010-08-20 08:14:57 jigfox

但是我怎樣才能得到像我發佈的兩個例子的佈局？我覺得那些標準佈局很好。 – 2010-08-20 08:22:08

是否可以自動生成這些類型的文檔？ http://www.ruby-whois.org/api/ – 2010-08-20 14:26:37

GitHub在每個存儲庫的基礎上提供webhooks（也就是說，您可以爲這個或那個回購啓用它，但不是在這裏的其他兩個）。其中一個webhook與rdoc.info捆綁在一起，它使用Yard來生成漂亮的文檔。（Yard本身與rdoc很相似，如果你知道rdoc，你將不會遇到任何麻煩。）例如：Yard's own docs。

在你的回購中，進入設置 - > Webhooks &服務 - > Webhooks添加一個合適的webhook。（有documentation for webhooks on GitHub's API site。有關如何自定義在存儲庫中掃描文件以查找文檔的信息，請參閱this page上的說明。）

來源

2010-08-20 13:41:14 Telemachus

爲什麼Rdoc.info不使用rdoc生成文檔？ – 2010-08-20 14:10:48

@ajsie如果你已經在使用'rdoc'，Rdoc.info會正常工作。我相信，'yard'是'rdoc'的超集。它們不是不兼容的。 Rdoc.info使用'yard'的原因是，其中一個網站創建者也是'yard'的創建者，構建Rdoc.info的人可能認爲'yard'比'rdoc'更強大。 – Telemachus 2010-08-20 15:09:16

還要注意，如果你連接到Rdoc.info，那麼無論何時你推送到Github（通過服務鉤子），文檔都會自動重新生成。 – Telemachus 2010-08-20 15:10:36

如何在GitHub中爲項目創建API文檔？

回答

相關問題