将OpenOffice / Libreoffice与Doxygen结果结合起来用于代码文档？

Question

问题

我们目前希望通过重复使用之前的OpenOffice结果，从手动迁移到自动C-Code文档。

背景

在过去10年中，我们手动生成了许多OpenOffice（* .odt）文件，包括类似于架构的prosa，“如何工作”，图形和详细的API描述。因此，我们为每个产品都有一个文档（为客户导出为* .pdf）。

我们现在更改了我们的C代码以使用Doxygen兼容格式和关键字，从而生成格式良好的文档（HTML + CHM，到目前为止还没有PDF）。但这当然包括详细的API。目标仍然是生成包括prosa＆amp; amp;图形。

考虑将OpenOffice和amp; Doxygen结果，我们想知道如何以及在哪个方向继续：

1. 转换* .odt =＆gt; * .html并在C-Code for Doxygen中引用这些
2. 转换* .odt =＆gt; * .txt / png并在C-Code for Doxygen中引用这些
3. 转换* .odt =＆gt; * .html作为基础并参考Doxygen-HTML-这些文件中的结果
4. 另一种可用的常用格式，用于合并两个结果（？）

问题

从旧文档样式迁移到等效的单个文档文件（包括Doxygen结果）可能是最有效的方法吗？

Answer 1

花了太长时间试图在Doxygen中建立完整的文档后，我最近转换为Sphinx + Breathe + Doxygen。我发现，使用可用文档可以抵消多个工具增加的复杂性。

Doxygen是您的API文档，保持内联有助于鼓励使用代码更新API。

Sphinx用于您的系统文档，体系结构描述等.Sphinx是一个基于重组文本的文档系统，您需要转换现有的ODT文档。

Breathe是一个桥梁，允许您将Doxygen文档带入Sphinx。 Doxygen被编译为XML，然后Breathe提取XML并将其推送到已编译的Sphinx文档中。

Sphinx可能还有其他替代方案。呼吸，但我强烈推荐像这样的分裂。它允许Doxygen执行它强大的API，并允许您使用您不必每天战斗的工具来执行更高级别的系统文档。