2010-11-15 182 views
11

有沒有辦法爲使用pip安裝的軟件包安裝/生成文檔?Python pip - 爲軟件包安裝文檔?

我希望爲項目安裝所有必需的軟件包,以及所有相關的文檔(例如安裝django時的Django文檔,使用dateutil的dateutil文檔等)。

點擊需求文件是快速安裝項目所需包的好方法,但如果我也可以安裝所有關聯的文檔,它會更好。

Ubuntu Python包將文檔安裝到/ usr/share/docs,但pip似乎沒有這樣做。

當我需要離線處理項目時,這些包的文檔對我來說很重要。

+0

我不知道從pip下載它,但很多開發人員都支持epydoc,您可以使用它自動生成文檔。 – Joshkunz 2011-02-04 17:32:00

回答

4

我認爲你正在尋找一種等價的方式,自動地(除非被壓制)從安裝的寶石/軟件包生成rdoc。

在Python中,有用於註釋代碼帶有文檔的標準化機制 - docstringsoptional formatting帶。然而,沒有一種從python代碼生成/存儲文檔的標準化方法。每個python包可能有不同的機制,所以沒有辦法讓pip生成它。