Ask Your Question
2

PyKDL documentation

asked 2011-09-16 11:26:15 -0600

Miguel Prada gravatar image

Is there any way to generate a complete html documentation for PyKDL (the version in python_orocos_kdl package in electric)?

So far I've tried using both rosdoc and pydoc. rosdoc outputs an html with only a couple of references to SIP (same as here), and pydoc.writedoc() does somewhat better, but not much.

I guess that this is due to SIP being used to wrap the C++ code, but the whole API is not available and the only way I've found so far to find out the exact python API is reading the .sip files, which is a bit cumbersome.

Any help would be appreciated.

edit retag flag offensive close merge delete

Comments

I just found this http://www.ros.org/doc/api/kdl/html/python/index.html. Not a complete reference either, but definitely better than checking the .sips.
Miguel Prada gravatar imageMiguel Prada ( 2011-09-26 01:38:55 -0600 )edit

2 Answers

Sort by ยป oldest newest most voted
2

answered 2012-03-20 02:13:57 -0600

I've added a sphinx builder configuration to the python_orocos_kdl package. It auto-generates the API for all available classes and functions in the PyKDL module. It uses the docstrings that are added by SIP and only include the API syntax, not the documentation from doxygen. But it gives an overview of what is available. The result can be found at http://people.mech.kuleuven.be/~rsmits/kdl/python

Ruben

edit flag offensive delete link more
1

answered 2011-10-09 15:17:50 -0600

Wim gravatar image

I'm not aware of a way to auto-generate the documentation, for the exact same reasons you mention (SIP). The documentation on http://www.ros.org/doc/api/kdl/html/python/index.html is manually generated (and incomplete), but it's the best API documentation of PyKDL I've seen.

edit flag offensive delete link more

Your Answer

Please start posting anonymously - your entry will be published after you log in or create a new account.

Add Answer

Question Tools

Stats

Asked: 2011-09-16 11:26:15 -0600

Seen: 1,349 times

Last updated: Mar 20 '12