【问题标题】:Offline Javadoc Server离线 Javadoc 服务器
【发布时间】:2011-05-10 21:27:10
【问题描述】:

由于并非我们所有的开发机器都可以访问互联网,我们希望在本地网络中缓存各种库的 API 文档。我正在考虑一个 web 应用程序,它在有人上传它们(以 jar 格式)后处理缓存和列出可用的 Javadocs。理想情况下,源 jar 会自动从我们的 maven 存储库(工件)中提取。

我在谷歌上没有成功找到类似的东西,所以我在这里试试运气。

编辑

我找到了一个完全符合我要求的网站:http://www.jarvana.com 问题是该网站不满足我的#1 要求 - 离线可用性。所以我把我的问题改写为:有没有像 jarvana 一样工作但可以部署到本地服务器的 webapp?

【问题讨论】:

    标签: java maven javadoc offline


    【解决方案1】:

    似乎我正在寻找的东西真的不存在,所以我推出了自己的非常简单的 web 应用程序,它从本地 maven 存储库提供 JavaDocs(透明地提取 jar 文件)。它远非完美,但它适用于我的要求。如果有人感兴趣,我在github上分享了:

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

    【讨论】:

      【解决方案2】:

      为什么不直接使用mvn site

      嗯,我最好添加一些比这更有用的东西:-)

      mvn 站点将构建和部署一系列站点报告,包括 javadoc(假设您配置了该插件)。每次您的 CI 服务器从 trunk/branch/tag/whereever 构建代码时,都会生成最新的 Javadocs 并将其存储在文件系统中(可通过 HTTP 访问)!

      甚至还有一个很酷的报告将 javadoc 与源代码联系起来。

      【讨论】:

      • 这意味着下载源代码并从头开始构建 Javadoc。所以它只适用于使用 maven 并且是开源的库。
      • 澄清一下:对于我们自己的库,这是一个很好的解决方案,但我们希望提供第三方库的文档。
      • 我认为不一定要从源代码构建javadocs。将它们下载到本地存储库并在 site.xml 中创建指向它们的链接。
      • 假设第 3 方库位于 Maven 中心(或其他仓库)中,我相信您可以下载他们的 javadoc.jar 并按照@AlexR 状态链接到它。
      【解决方案3】:

      你可以试试wwwoffle。一个缓存代理,可让您在离线时访问网站。

      【讨论】:

      • 谢谢,但这不是我想要的。我已经使用递归 wget 来获取文档。所有这些东西都有效,但只提供一个 jar 文件(或从 maven 获取)会容易得多。
      【解决方案4】:

      我前段时间写了一个 python 脚本来从我的本地 maven repo 中提供 javadoc:

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

      python javadoc.py
      

      这很粗略,但点击 http://localhost:8080/m2 将列出您本地 maven 存储库中的所有项目以及下载的文档。

      您可以通过以下方式下载 maven 项目的所有 javadoc jar:

      mvn dependency:resolve -Dclassifier=javadoc
      

      【讨论】:

        猜你喜欢
        • 2012-03-20
        • 2015-03-07
        • 2013-08-17
        • 2022-11-03
        • 2014-04-02
        • 2015-05-13
        • 1970-01-01
        • 2011-08-29
        • 1970-01-01
        相关资源
        最近更新 更多