C ++中的Sphinx（Linux） [英] Sphinx in C++ (Linux)

问题描述

这次我想在 Linux 中实施 Sphinx 。请给我 API ，这样做或相关链接也会这样做。虽然我发现很多PHP，但是没有C ++。

This time I want to implement Sphinx in Linux. Please give me the API required to do the same or the concerned link will also do. Although I found many for PHP, however none for C++.

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

I have also used GTKmm in my application.

推荐答案

是没有API做到这一点。 Sphinx将以reStructuredText格式处理文本文件，并将其转换为文档。从源代码中提取文档的能力只适用于python代码。对于其他语言，您需要将文档直接放在reStructuredText文件中。不要被添加的C / C ++ /等混淆。支持Sphinx 1.0：这只包括新的reStructeredText指令以更好地格式化（和索引）非python代码的文档。

There is no API to do this. Sphinx will process text files in reStructuredText format and turn them into documentation. The ability to extract documentation from source code is only present for python code. For other languages you will need to put the documentation in the reStructuredText files directly. Do not be confused by the added C/C++/etc. support in Sphinx 1.0: this only covers new reStructeredText directives to better format (and index) documentation regarding non-python code.

理论上可以使用一个工具，如Doxygen从C ++源提取文档并在Sphinx中使用它，但这需要自定义工具。 呼吸可能是一个这样的工具。

It is theoretically possible to use a tool like Doxygen to extract documentation from C++ sources and use that in Sphinx, but this requires custom tools. Breathe may be one such tool.

这篇关于C ++中的Sphinx（Linux）的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！