产生升压蟒蛇参考

Question

大家有一个想法，我怎么可以自动生成的我宣布升压Python方法的引用：

def("foo", foo, args("x", "y"), "foo's docstring") 
def("foo2", foo, args("x", "y"), "foo's docstring") 
def("foo3", foo, args("x", "y"), "foo's docstring") 
def("foo4", foo, args("x", "y"), "foo's docstring") 

Answer 1

您可以使用sphinx。你需要稍微修改一下，使函数参数列表更漂亮，参见例如。我为minieigen做了什么：boost::python source,sphinx config file和generated docs。

对于沿着同一条线但更复杂的东西，请看Yade。

Answer 2

使用Sphinx，这是事实上的Python文档生成器。没有必要修改狮身人面像。

狮身人面像从docstrings中提取文档，所以添加文档来记录你的Boost Python模块。像平常一样将其编译为共享对象（.so文件）。

为每个模块创建一个.rst文件。例如，对于模块demo.foo创建demo.foo.rst：

.. automodule:: demo.foo 
    :members: 
    :undoc-members: 
    :show-inheritance: 

然后，设置和运行狮身人面像，它将使不错的文档，您在多种格式。