C ++中的Sphinx(Linux)

问题描述 投票:1回答:2

这次我想在Linux中实现Sphinx。请给我执行相同操作所需的API或相关链接也可以。尽管我发现有很多PHP方面的内容,但是C ++方面却没有。

我也在我的应用程序中使用了GTKmm。

c++ linux python-sphinx
2个回答
3
投票

没有API可以执行此操作。 Sphinx将处理reStructuredText格式的文本文件并将其转换为文档。从源代码提取文档的功能仅适用于python代码。对于其他语言,您需要将文档直接放在reStructuredText文件中。不要被添加的C / C ++ / etc所迷惑。 Sphinx 1.0中的支持:仅涵盖新的reStructeredText指令以更好地格式化(和索引)有关非Python代码的文档。

从理论上讲,可以使用Doxygen之类的工具从C ++源中提取文档,并在Sphinx中使用它,但这需要自定义工具。 Breathe可能是这样一种工具。


0
投票

[这里的资源几乎完全解释了构建C / C ++源代码树以显示在Sphinx文档中所需的所有步骤。

https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/

[管道简介:Doxygen->呼吸->呼气->狮身人面像

© www.soinside.com 2019 - 2024. All rights reserved.