ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange
Ask Your Question

Is's Code API generator supposed to work with python code imported using

asked 2012-02-23 06:57:35 -0500

updated 2012-02-23 08:55:47 -0500

kwc gravatar image


I am using in to fetch teer's source code into ROS. Currently, there is no "Code API" generated for it; is it because the generator is busy/overloaded or because it is not supposed to index fetched code? If the latter explanation is the right one, what is the best practice to document inside ROS code fetched from outside (be it with git_checkout, svn_checkout or tarball's import)?

Thank you, kind regards

edit retag flag offensive close merge delete

2 Answers

Sort by » oldest newest most voted

answered 2012-02-23 08:54:43 -0500

kwc gravatar image

The indexer does not 'build' any code that it runs the generator against (see NOTE). requires building the code. In the past, we attempted to add this feature to the indexer, but it simply is intractable for it to successfully build arbitrary code checkouts, for numerous reasons.

If you wish to document fetched code, then the way to do that is to submit the fetched code separately to the indexer, or manually generate the documentation yourself and upload to an appropriate location.

NOTE: The only exception is documentation for diamondback/electric versioned docs, which is only for released/debian-ized stacks. This feature is going away as, starting in Fuerte, stacks are no longer including source within the installed layout.

edit flag offensive delete link more

answered 2012-02-23 22:57:17 -0500

Thank you for the answer. I am now using git submodules to fetch the upstream teer in a subdirectory inside teer_ros. That should solve the issue nicely.

edit flag offensive delete link more

Question Tools


Asked: 2012-02-23 06:57:35 -0500

Seen: 659 times

Last updated: Feb 23 '12