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

How can I generate wiki docs with Epydoc? [closed]

asked 2013-11-12 11:35:38 -0500

Jim Rothrock gravatar image

Using the default API documentation generator (Doxygen), the code API docs for are generated correctly. I want to use Epydoc instead of Doxygen, so I made the following changes:

  • In ackermann_vehicle_gazebo/package.xml, I added a rosdoc element:
    <rosdoc config="rosdoc.yaml"/>
  • In ackermann_vehicle_gazebo, I created a rosdoc.yaml file:
- builder: epydoc
  config: epydoc.config
  • In ackermann_vehicle_gazebo, I created an epydoc.config file:
modules: nodes/*.py
docformat: restructuredtext
private: no

After making these changes, I received an e-mail from with the subject "Build failed in Jenkins: doc-hydro-ackermann_vehicle #13". The mail contains a large number of messages, but I can't determine the error that caused them. What do I need to do in order to generate code API docs with Epydoc instead of Doxygen?

edit retag flag offensive reopen merge delete

Closed for the following reason the question is answered, right answer was accepted by Jim Rothrock
close date 2014-09-23 15:47:17.852584


It would help to post a link to the Jenkins doc job that failed. Can you run ``rosdoc_lite`` locally on your development system?

joq gravatar image joq  ( 2013-11-12 11:47:09 -0500 )edit

Yes. If I do the following:

    cd catkin_ws/src/ackermann_vehicle/ackermann_vehicle_gazebo
    rosdoc_lite .
Documentation is written to ackermann_vehicle_gazebo/doc.

Jim Rothrock gravatar image Jim Rothrock  ( 2013-11-12 11:53:23 -0500 )edit

2 Answers

Sort by ยป oldest newest most voted

answered 2014-09-21 14:18:23 -0500

Dirk Thomas gravatar image

The first problem is that rosdoc_lite ignores any output coming from epydoc which makes debugging / analyzing anything impossible. I have fixed this in:

The second problem is that the epydoc.config file seems to be incorrect. When specifying the module file explicitly (rather then using wildcard matching) it started to generated html code. The patch for the ackermann_vehicle_gazebo package is here:

edit flag offensive delete link more

answered 2013-11-12 13:02:04 -0500

joq gravatar image

I assume your rosdoc_lite output must look reasonable. So, the problem must be with the build farm.

I've had two similar rsynch error messages from the build farm recently. I suspect it's a transient problem with Jenkins.

If it doesn't start working shortly, I recommend sending a message to about this failure. You can include a link to this question to avoid repetition.

edit flag offensive delete link more


Yes, the rosdoc_lite output is correct. I'll keep an eye on the docs and see if the problem goes away. Thanks for the help.

Jim Rothrock gravatar image Jim Rothrock  ( 2013-11-12 13:14:47 -0500 )edit

Question Tools

1 follower


Asked: 2013-11-12 11:35:38 -0500

Seen: 446 times

Last updated: Sep 21 '14