PyKDL documentation

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

1071 ●18 ●27 ●32

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 ( 2011-09-26 01:38:55 -0500 )edit

add a comment

2

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

Ruben Smits
543 ●4 ●10 ●16 http://www.intermodalics.eu/

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

add a comment

1

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

Wim
2915 ●14 ●34 ●43

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

add a comment

PyKDL documentation

Comments

2 Answers

Question Tools

Stats

Related questions

PyKDL documentation edit

Comments

2 Answers

Question Tools

Stats

Related questions

PyKDL documentation