2010-11-16 113 views
2

由於並非我們所有的開發機器都能訪問互聯網,因此我們希望在本地網絡中緩存各種庫的API文檔。我正在考慮一個處理緩存的Web應用程序,並在有人上傳這些可用的Javadoc之後列出它們(以jar格式)。理想情況下,源jar將自動從我們的maven倉庫(artifactory)中提取。脫機Javadoc服務器

我在google上找不到這樣的東西,所以我在這裏試試我的運氣。

編輯

我發現,正是我要尋找爲什麼網站:http://www.jarvana.com的問題是,這個網站不履行我的#1的要求 - 脫機可用性。所以我把我的問題改爲:有沒有像jarvana一樣工作的webapp,但可以部署到本地服務器?

回答

3

看起來我所尋找的東西實際上並不存在,所以我推出了自己真正簡單的webapp,它可以從本地maven存儲庫(透明地提取jar文件)提供JavaDocs。這遠非完美,但它適用於我的要求。如果有人有興趣,我分享了它在GitHub上:

https://github.com/planbnet/JavaDoc-Browser

2

爲什麼不只是使用mvn site

嗯,我最好還是補充一點比:-)

MVN網站將建立和部署了一堆網站報道,包括javadoc的更多有用的(假設您配置插件)。每當您的CI服務器從trunk/branch/tag/whereever生成代碼時,最新的Javadoc將被生成並存儲在文件系統上(可通過HTTP訪問)!

甚至還有一個很酷的報告,將javadoc鏈接到源代碼中。

+0

這將意味着下載源,從頭開始構建的Javadoc。所以它只適用於使用maven並且是開源的庫。 – FRotthowe 2010-11-16 15:35:53

+0

只是爲了澄清:對於我們自己的圖書館來說,這是一個很好的解決方案,但我們希望提供第三方庫的文檔。 – FRotthowe 2010-11-16 15:42:30

+0

我認爲它不一定是從源代碼構建javadoc。將它們下載到本地存儲庫並在site.xml中創建它們的鏈接。 – AlexR 2010-11-16 15:53:35

0

您可以試一試wwwoffle。緩存代理,可在您離線時訪問網站。

+0

謝謝,但那不是我想要的。我已經玩過一個遞歸wget來獲取文檔。所有這些東西都能正常工作,但只要提供一個jar文件(或者從maven那裏獲得該文件)就會容易得多。 – FRotthowe 2010-11-16 15:43:49

0

我寫了一個Python腳本,前一段時間,從我的本地Maven回購服務的Javadoc:

http://blog.robotninjas.org/2013/04/17/accessing-your-cached-javadoc-offline/

python javadoc.py 

這很粗糙,但打到http://localhost:8080/m2將列出您的本地maven存儲庫中的所有項目與下載的文檔。

您可以下載所有的Javadoc罐子Maven項目有:

mvn dependency:resolve -Dclassifier=javadoc