我想将文档放在我正在处理的项目的 confluence wiki 上,并且我想从 javadocs 自动生成一些文档。是否有一个 confluence 插件可以让这变得简单(在初步搜索中没有看到),或者有没有人编写脚本来基于 javadocs 将 wiki 页面发布到 confluence?蚂蚁任务可能很酷,然后我可以将 wiki 作为目标。
3 回答
Confluence JavaDocs Macros 是一个从 javadocs 生成 wiki 页面的插件。缺点是 zip 存档必须由 javadocs 组成并放在空间的第一页,并且多个 javadoc 不能共存于同一空间。
该插件也不兼容所有版本的 Confluence。
如果你只有一个 confluence 服务器(或者 confluence 服务器是文档的主要位置)来托管你的文档,你可能想要将 javadocs 添加到 confluence 中......以前发生过。
您可以使用文档插件:https ://marketplace.atlassian.com/plugins/net.meixxi.confluence.docs.docs-plugin 。这个插件使您能够在 Confluence 中上传和发布您的 JavaDocs 和其他基于 HTML 和 JavaScript 的内容。
Docs 还提供了一个 REST 接口以自动化发布过程。因此,发布 JavaDocs 可以成为持续集成过程的一部分。您可以在此处找到技术文档和示例代码:https ://ricebean.net/confluence-docs
为什么要将 javadoc 上传到编辑系统中?这听起来很奇怪。我们创建了一个上传项目文档的 apache 服务器(它是从 Java 创建的 javadoc 和一些项目文档(我们也存储在项目中(在 SCM 中))。
除此之外,我们还有一个 Wiki 系统,每个人都可以在其中编写各种内容。在大多数 wiki 中很容易进行外部引用(对 Apache 网络服务器、项目文档/javadoc 页面)。
这样做的好处是,可以通过 ant/maven/etc. 重新生成项目文档并自动上传到某个 web-server。那里只能红色不能修改。这只能通过项目资源来完成。这很好,因为否则人们开始编辑 wiki 页面,然后不时被替换,因为创建了一个新的构建/发布。