如何在Java项目中将版本化的JavaDoc / Site发布到github页面?

时间:2015-09-19 18:08:59

标签: java maven github github-pages

如果项目名为foo,我想为不同版本的单独目录发布Javadoc,例如:

me.github.io/foo/1.0/apidocs/
me.github.io/foo/2.0/apidocs/

此处讨论了类似的问题:https://github.com/github/maven-plugins/issues/22但问题似乎并未解决

1 个答案:

答案 0 :(得分:9)

我使用javadoc.io在Github上为我的开源项目托管javadoc,然后从readme.md和github页面链接到该文件(例如,这里是我的一个项目的最新版本的javdoc: http://www.javadoc.io/doc/com.aol.simplereact/simple-react/0.99.2)。

设置起来非常简单。一旦您发布到Maven Central或bintray(包括您的来源),请浏览

http://www.javadoc.io/doc/<group id>/<artefact id>/<version>

这会将您的库添加到系统中,它应该下载javadoc并在一天内(有时立即)将其添加到站点。

它比自己管理流程更好,并且保证与人们正在使用的代码的实际版本(以及他们在IDE中看到的源代码)相匹配,因为它已下载来自Maven Central的相同版本回购。 (如果您自己管理,可能会将不同版本上传到Maven Central和您的托管网站。)