狮身人面像和氧气的主要区别是什么?

What are the main differences of Sphinx and Doxygen?

本文关键字：区别 是什么 氧气      更新时间：2023-10-16

我想为计算机视觉领域的一系列项目、模块和库(主要用c++编写)准备一份文档。为此，我看了看OpenCV文档，你可能知道OpenCV 2.4。x文档是基于Sphinx，这是我正在寻找的确切的解决方案。Sphinx的优点有:

  1. 模块的语义层次结构。例如卡尔曼滤波器是运动分析和目标跟踪模块
    2. 的子模块。
  2. 您可以添加图像和数学公式
  3. 相当不错的嵌入式搜索引擎

但是我意识到c++版本的OpenCV3.0是基于氧文档的，我不知道为什么!因为它没有狮身人面像有趣。我知道氧可以编译你的代码和提取你的注释，这是一个有用的功能。我也知道有一些库(比如breathe)可以作为 oxygen和Sphinx之间的桥梁。

现在我的问题是:

    Sphinx和 oxygen是彼此的替代品还是可以一起使用?氧是否具有上述Sphinx的特征?
  1. 哪个文档引擎(Sphinx， 氧或其他引擎)你更喜欢我的问题?

这个答案回答了你问题的第二点。

是的，氧部分具有这些特征。

  • 可以有数学公式，可以通过本地Latex安装或通过MathJax(一个Javascript呈现库)呈现。与Latex一样，它们既可以"嵌入"到文本中，也可以作为文本流中的单独单元。
    • 它还包括一个搜索引擎。您可以轻松地包含图像。
例如，下面两行代码将在html和latex生成的输出中添加相同的图像: 
  image latex my_image.png "My image" width=10cm
  image html my_image.png "My image" width=10cm

我想我记得在html中，标题和宽度被忽略了吗?但是氧是非常灵活的，所以如果上面的命令还不够，你可以把它们添加为html代码:

<img src="my_image.png"  ...additional html attributes...>

氧还支持很多常规的html命令，你可以直接包括在你的注释块。

除了构建Opencv手册外，我没有Sphinx的经验，但是我可以补充的是(我每天都在使用)，它真的很灵活，但这并不意味着它总是最好的选择。页面可能会变得混乱，如果注释附加代码设计得不好，它可能会妨碍您。

为了完整起见，最好的展示氧可以做什么的例子之一(当然除了氧网站)是Eigen库。

相关文章：