Search code examples
c++pythonboostdocumentationboost-python

generate a boost-python reference

Has anybody an idea how can I generate automatically a reference of my declared boost-python methods:

 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")
Solution

  • You can use sphinx. You need to hack it a bit to make functions argument lists prettier, see e.g. what I did for minieigen: boost::python source, sphinx config file and generated docs.

    For something along the same line, but more complex, have a look at Yade.