使用maven创建文档

Question

我正处于重访maven的过程中.当我们上次查看这个时,我们的团队经历了糟糕的经历,因为在maven从1.x重新架构到2.x期间,我们需要的很多依赖项没有被移动到新的存储库中.但是,我现在有时间重新考虑.

我有兴趣使用maven和LaTeX或DocBook来创建文档,我想知道是否有人有任何共享经验,项目/模块结构,使用好的插件等等...

非常感谢 :-)

编辑:

只是为了澄清,我正在寻找一篇技术文章/书,而我想要的工件可能是PDF.

Answer 1

DocBook是Doxia的众多支持输入之一,Doxia是用于通过maven生成docs的引擎.请参阅此处:http://maven.apache.org/doxia/modules/index.html

事实上,Doxia网站会回答您的确切问题:http://maven.apache.org/doxia/book/index.html

Answer 2

您可以使用mvn site命令(即使用插件站点)轻松地使用Maven创建一个站点(包含文档).

此插件创建技术报告(例如Javadoc,单元测试报告,代码覆盖率......),但也可用于创建"真实站点".您在此页面中有更多详细信息.

基本上,您使用APT(几乎是纯文本,非常容易理解)或基于XML的格式Xdoc来编写页面.

2年前,我使用XDoc格式和Site Maven插件为我开发的一个应用程序创建了完整的用户指南.在全球范围内,它很容易创建!

我希望这能帮到您!

Answer 3

我最近使用 docbook 和 maven 的 docbkx 插件实现了我的 Maven 多模块项目的项目文档。现在，我每次构建项目站点时都会自动生成 html 和 pdf 文件。我认为 docbkx 真的很棒，所以我建议你使用它。

这是真的——你可以使用 Maven 站点和 doxia 插件创建一个非常好的站点。事实上，我正在使用这两个来生成我的项目站点，但是 doxia 对 docbook 的支持非常有限，并且不允许您模块化文档，例如，包括主文档中的部分文档。因此，对于大型参考手册，我使用的是 docbkx。

如果你想看一下，我的项目在这里。您实际上可以下载源代码并查看其实质内容。当然，如果您对此设置有任何疑问，我将非常乐意提供帮助。

干杯卡洛斯