使用Sphinx从SWIG的C++ API文档化Python

Question

我基本上在问一个和这个问题差不多的问题：有没有好的方法来为swig接口生成文档？

不过那个问题已经有两年了，现在有了sphinx这个工具。

我的问题是，sphinx能不能自动从swig生成的python代码中提取一些内容，还是说需要手动把C++代码里的文档重新输入一遍？

Answer 1

SWIG 目前还不支持从 C++ 头文件中的注释中提取类、方法或函数的文档。你能做到的最接近的方式是使用 %feature("autodoc", level) 和 %feature("docstring")，具体的内容可以参考 SWIG 文档的第 36.10 文档字符串特性 部分。看起来在 2012 年的一个项目中，有人尝试扩展 SWIG 以识别 Doxygen 标签，从而生成 javadoc 和 Python 的文档字符串，但自那以后似乎没有进一步的进展。