如何将项目的Java文档发布到github？

Question

我想在 Github 上发布一个项目。 它可以工作，我可以通过 Gradle 将其作为依赖项检索。 但是缺少 JavaDoc。

信息：

注意：该元素既没有附加源也没有附加 Javadoc，因此找不到 Javadoc。

我需要构建 JAR 吗？ 或者有什么方法可以将我的 JavaDoc 添加到项目中，以便使用 gradle 构建 JavaDoc？

Answer 1

不要将 JavaDoc 发布到 (a) Github（存储库），因为 JavaDoc 是 Java 源代码的派生产品。

让我们想一想，当您更改 JavaDocs 中的注释时，您的 JavaDocs Github 存储库也需要更改。 这是冗余。

Let 's see few well-known Java projects on Github, such as, https://github.com/spring-projects/spring-boot , they don't put any JavaDoc (HTML files) in a GitHub repository.

Task generate JavaDocs by Gradle: https://docs.gradle.org/current/dsl/org.gradle.api.tasks.javadoc.Javadoc.html

Answer 2

您可以使用docs/文件夹或gh-pages分支在 GitHub 上发布您生成的 JavaDoc。

示例：来自github.com/ebourg/jsign/tree/gh-pages的github.com/ebourg/jsign/tree/gh-pages 。

另一种方法是将您的可交付成果（jar 和 javadoc.jar）发布到二进制引用（ Central Maven或Bintray ），并让第三方服务为您公开 Javadoc。
参见“ www.javadoc.io ”