使用Maven创建文档 [英] Creating documentation with maven

问题描述

我正处于重新审视行家的过程中.我们的团队在上次查看此文档时经历了一段糟糕的经历，因为当时maven从1.x重新配置为2.x，因此我们所需的许多依赖项并没有转移到新的存储库中.但是，我现在有时间重新考虑.

I'm just in the middle of revisiting maven. Our team had a bad experience when we last looked at this, as it was during the period when maven was rearchitecting from 1.x to 2.x, so a lot of the dependencies we needed hadn't been moved across to the new repositories. However, I have the time to reconsider now.

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

I am interested in using maven and either LaTeX or DocBook for creating documentation, and I was wondering if anyone had any experiences to share, project/module structure, good plugins to use, etc...

非常感谢:-)

请澄清一下，我当时想写一篇技术文章/书，而我想要的工件可能是PDF.

Just to clarify, I was looking to write a technical article/book, and my desired artifact would probably be a PDF.

推荐答案

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

I recently implemented the project documentation for my maven multi-module project using docbook and the docbkx plugin for maven. I now have it automatically generating html and pdf files every time I build the project site. I think docbkx really rocks, so I would suggest you use that.

这是真的-您只需使用maven网站和doxia插件即可创建一个非常不错的网站.实际上，我正在使用这两者来生成我的项目站点，但是doxia对docbook的支持非常有限，并且不允许您模块化文档，例如，将主文档中的部分文档包含在内.因此，对于大型参考手册，我使用的是docbkx.

Its true -you can create a very nice site just using the maven site and doxia plugins. In fact I'm using those two to generate my project site, But doxia support for docbook is very limited and doesn't let you modularize documentation, including parts of documents in a main document, for instance. So for the big reference-manuals I'm using docbkx.

如果您想看一眼，我的项目是此处.实际上，您可以下载源代码并查看其精髓.而且，当然，如果您对此设置有任何疑问，我将非常乐意为您提供帮助.

If you want to take a peek, my project is here. You can actually download the source and see the nitty gritty of it. And, of course, if you have any question regarding this setup, i'll be more than glad to help.

欢呼 卡洛斯

这篇关于使用Maven创建文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！