2010-11-16 69 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