C++ 的狮身人面像(Linux)
这次我想在Linux中实现Sphinx。请给我执行相同操作所需的API,或者相关链接也可以。虽然我找到了很多 PHP 的,但没有找到 C++ 的。
我还在我的应用程序中使用了 GTKmm。
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++.
I have also used GTKmm in my application.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
没有 API 可以执行此操作。 Sphinx 将处理 reStructuredText 格式的文本文件并将其转换为文档。从源代码中提取文档的功能仅适用于 python 代码。对于其他语言,您需要将文档直接放入 reStructuredText 文件中。不要被添加的 C/C++/etc 所迷惑。 Sphinx 1.0 中的支持:这仅涵盖新的 reStructuredText 指令,以更好地格式化(和索引)有关非 python 代码的文档。
理论上可以使用 Doxygen 这样的工具从 C++ 源代码中提取文档并在 Sphinx 中使用,但这需要自定义工具。 Breathe 可能就是这样的工具之一。
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.
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/C++ 源代码树以与 Sphinx 文档一起显示所需的所有内容。
https://devblogs.microsoft .com/cppblog/clear-function-c-documentation-with-sphinx-breathe-doxygen-cmake/
管道简介:Doxygen ->呼吸->呼气->狮身人面像
Here is the resource that pretty much explains everything step-by-step that is needed to build a C/C++ source tree to show up with Sphinx documentation.
https://devblogs.microsoft.com/cppblog/clear-functional-c-documentation-with-sphinx-breathe-doxygen-cmake/
A brief of the pipeline: Doxygen -> Breathe -> Exhale -> Sphinx