Sphinx和来自swigged C ++ api的python记录

Question

我基本上问这个问题：Is there a good way to produce documentation for swig interfaces?

然而，那一个就像两岁，现在有狮身人面像。

问题是，sphinx可以自动从swig产生的python代码中获取一些东西，还是需要手动“重新输入”C ++代码中的文档？

Answer 1

SWIG尚不支持从C ++头文件中的注释中提取类/方法/函数文档。您可以获得的最接近的是%feature("autodoc", level)和%feature("docstring")，如SWIG文档36.10 Docstring Features部分所述。看起来有些工作在扩展SWIG以识别Doxygen标签以生成javadoc和python docstrings是"Summer of Code 2012"的一部分，但它看起来没有任何进一步的工作，因为它。