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

Gazebo documentation not in HTML format [closed]

asked 2011-03-10 05:12:22 -0500

Jim Rothrock gravatar image

updated 2011-03-10 13:02:28 -0500

tfoote gravatar image

I'm looking at the C Turtle Gazebo documentation in /opt/ros/cturtle/stacks/simulator_gazebo/gazebo/build/gazebo/doc. I built C Turtle on an Ubuntu 10.04 LTS machine. The Gazebo HTML files are not in HTML format. For example, here is the beginning of mainpage.html:

/** \mainpage Gazebo

Gazebo is a multi-robot simulator for both indoor and outdoor environments. Like Stage, it is capable of simulating a population of

It appears that the documentation is in Doxygen format. I ran "rosmake simulator_gazebo", which said everything had been built correctly. Is there something else I need to do to get HTML Gazebo documentation?

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 2013-09-30 11:43:28

2 Answers

Sort by ยป oldest newest most voted

answered 2011-03-10 12:52:04 -0500

tfoote gravatar image

updated 2011-03-10 12:53:08 -0500

In general to generate the html form of documentation found on the wiki use the rosdoc tool

rosrun rosdoc rosdoc gazebo

should generate the output you want. Note it will generate a folder "doc" in the current working directory with it's output.

edit flag offensive delete link more

answered 2011-03-10 08:55:10 -0500

Chad Rockey gravatar image

updated 2011-03-10 08:58:38 -0500

Gazebo documentation is available as part of the player-stage project. The specific main page is located here:

The documentation for the ROS side of things is, of course, located on the ROS wiki.

If you'd like a copy local, I'm not a wget genius, so someone please correct me if this is wrong, but I think you run wget -r -p and it should download all the needed files for the documentation...

See the wget documentation for better help.

edit flag offensive delete link more

Question Tools


Asked: 2011-03-10 05:12:22 -0500

Seen: 297 times

Last updated: Mar 10 '11