產生升壓蟒蛇參考

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: 

然後，設置和運行獅身人面像，它將使不錯的文檔，您在多種格式。