自动将 JavaDoc 发布为远程机器上的功能网站

Far*_*har 4 javadoc repository nexus maven

将其上传到 Nexus Maven 存储库后,是否可以自动发布为实时网站 javadoc?我有一些软件包,它们正在不断开发中,我希望在将更新的代码上传到我们的远程存储库后,其他团队成员可以直接浏览它们的文档。

是否有任何现成的解决方案可以这样做,或者我是否必须编写一个 shell 脚本(在成功将代码部署到远程存储库后由 Maven 执行),它将文档复制到 Web 服务器上的远程位置?

我知道 Nexus Professional 允许开箱即用地查看 javadoc,但即使对于 10 个用户来说也有点贵,所以我希望有一个不同的解决方案:-)

我正在使用 Eclipse@Windows + Maven 2。

谢谢!

Ram*_*tra 6

如果您的项目是开源的并且已发布到Maven Central,那么您的 javadoc 将自动在javadoc.io上可用。

网址的格式为: http://www.javadoc.io/doc/[groupId]/[artifactId]. 例如,我在www.javadoc.io/doc/me.ramswaroop.jbot/jbot 上有我的项目的 javadoc

  • 哇,javadoc.io 太棒了。谢谢。 (2认同)

Man*_*ser 2

Nexus Open Source 和 Nexus Professional 支持站点存储库格式,该格式允许您托管 Maven 生成的站点。如果您设置发布一个 Maven 站点,其中包含 Javadoc 作为构建的一部分,您可以在那里访问它们。

您可以做的另一件事是在构建过程中发布 javadoc 和源工件,然后 Eclipse 将能够自动从 Nexus 下载它们,因此您甚至不需要为开发人员提供带有 javadoc 的网站。

当然,其他人可能也想要这个网站。

像往常一样,Nexus 书中提供了有关所有内容的文档。