search

ros-infrastructure / rosdoc_lite

A light-weight version of rosdoc that does not rely on ROS infrastructure for crawling packages.
10 stars 31 forks source link

rosdoc_lite: fix documentation on wiki.ros.org #37

Closed jack-oquin closed 7 years ago

davetcoleman commented 7 years ago

I think this question goes here... it appears there is no longer correct steps on the main wiki page http://wiki.ros.org/rosdoc_lite :

In order to enable the rosdoc configuration file, you must place the following tag in the <export>...</export> section of the package.xml (or manifest.xml in rosbuild-based packages, which is getting less standard after ROS Hydro) file:

<export>
  <rosdoc config="rosdoc.yaml" />
</export>
rosdoc.yaml should be the path to the configuration file you wish to use.

Because https://github.com/ros-planning/moveit_ros/tree/kinetic-devel/visualization does not have that tag in its package.xml but everything still builds fine and is live on the website. I'll remove it if someone +1's this

jack-oquin commented 7 years ago

+1, but note that the export is probably still necessary if you choose to name the file something other than rosdoc.yaml.

davetcoleman commented 7 years ago

Done.

In order to enable the rosdoc configuration file, simply have a rosdoc.yaml file in the root of your package. If you wish to name it something else, you must place the following tag in the <export>...</export> section of the package.xml, but this behavior is old:

I also removed "new in Fuerte" ;-)

jack-oquin commented 7 years ago

Thanks, Dave!