[ros-users] New Documentation Generation and Indexing for ros.org

[Eitan Marder-Eppstein]

Hey all,

So, as part of the infrastructure changes that we're making for ROS Groovy,
we've revamped the way documentation generation and indexing works. The new
system handles cross-referencing of Doxygen properly, is capable of
documenting catkin packages, and can run documentation generation with
independent jobs for each repository indexed. To support this new system,
there is a new documentation generation tool for ROS called rosdoc_lite,
which is a stripped down version of rosdoc that adds support for Doxygen
cross-references and catkin. For more information on using rosdoc_lite as a
standalone tool, please see http://ros.org/wiki/rosdoc_lite.

Since catkin packages were never properly documented and indexed in Fuerte,
we've also decided to roll out this new documentation indexer for Fuerte in
addition to Groovy. This means that, if you have Fuerte or Groovy packages
that you'd like to have indexed and documented on ros.org, you'll need to
register them with the new indexing system. For detailed instructions on
how to add your packages to the index, please see this
page<http://www.ros.org/wiki/Get%20Involved#Indexing_Your_.2A-ros-pkg_Repository_for_Documentation_Generation>,
but it should be as simple as creating a rosinstall file for your stack,
metapackage, or repository group.

The new documentation also comes with updated wiki macros for generating
package and stack headers on ros.org. These headers have tabs for
diamondback, electric, fuerte, and groovy that you can easily switch
between. They also allow you to include distro specific information with
each package (much like with the version macro). For more information on
these new headers, and how they work, please see:
http://www.ros.org/wiki/WikiMacros. Since they are backwards compatible,
we've already switched the wiki over.

On a logistical note, we're already using the new indexer to build
documentation for Groovy packages, but have not switched the wiki over to
use the new indexer for Fuerte quite yet. First, we want to make sure that
the community has a chance to add their packages to the indexer. So, within
the next two weeks, please take some time to add any package you maintain
to the indexer. Once again, to do this, please follow the instructions
here<http://www.ros.org/wiki/Get%20Involved#Fuerte_and_later>
.

Some useful pages:

Tickets for rosdoc_lite (
https://github.com/ros-infrastructure/rosdoc_lite/issues)
Tickets for indexing system (
https://github.com/ros-infrastructure/jenkins_scripts/issues)

Hope all is well,

Eitan

-- 
Eitan Marder-Eppstein
President, hiDOF Inc.
http://www.hidof.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osuosl.org/pipermail/ros-users/attachments/20121022/00dfaa9e/attachment-0003.html>