[ros-users] Versioned Code API documentation now available for released stacks/packages

Ken Conley kwc at willowgarage.com
Sun Aug 7 20:33:48 UTC 2011

On Sun, Aug 7, 2011 at 1:26 PM, Ingo Lütkebohle <iluetkeb at gmail.com> wrote:
> Very nice :-) I recently missed that and am glad its there now.
> Is the infrastructure code for that available?

All code for the wiki infrastructure is available, but not very well
documented.  Most of it is in the 'rosorg' and 'ros_release' stack.

I've included the build config we use the generate the docs below.


#!/usr/bin/env bash
set -o errexit

sudo apt-get install python-setuptools mercurial git-core
python-sphinx -y 1> /dev/null

echo "installing index via rosinstall"
sudo easy_install -U rosinstall
sudo apt-get install ros-$DISTRO-ros -y
rosinstall /tmp/rosdoc_checkout
--rosdep-yes  --continue-on-error
cat /tmp/rosdoc_checkout/setup.bash
cat /tmp/rosdoc_checkout/setup.sh
. /tmp/rosdoc_checkout/setup.bash

roscd rosdoc_rosorg && rosrun rosdoc_rosorg install_distro_index.py
rosmake rosdoc_rosorg --rosdep-install --rosdep-yes

echo "running rosdoc_rosorg on index"
roscd rosdoc_rosorg && rosrun rosdoc_rosorg rosdoc_rosorg.py -o
/tmp/doc --upload=wgs32:/path/to/www.ros.org/html/doc/$DISTRO/api

 - Ken

> Ingo
> On Thu, Aug 4, 2011 at 12:13 AM, Ken Conley <kwc at willowgarage.com> wrote:
>> One of the benefits of having released stacks is that it lets our
>> indexer associated your code with particular ROS releases.  We've now
>> upgraded our indexer to start producing version-appropriate
>> documentation for Code API (e.g. doxygen, epydoc, sphinx) resources.
>> We hope that this will make it easier for users to find relevant
>> documentation, as well as easier for authors to manage documentation
>> across multiple versions.  Due to infrastructure issues, we only
>> support Diamondback and later releases.
>> If you go to the wiki page for a released package, you will see
>> updated links under "Code API" and "Msg/Srv API" in the right-hand
>> navigation bar.
>> Examples:
>> http://www.ros.org/wiki/tf
>> http://www.ros.org/wiki/sensor_msgs
>> Feedback is welcome.  We are also looking for doxygen experts out
>> there for assistance in making our doxygen template prettier.  If you
>> would like to lend a hand, please drop me a line.
>> NOTE: this new documentation is produced from the debian packages
>> associated with a stack release.
>>  -- your friendly neighborhood ROS Indexers
>> _______________________________________________
>> ros-users mailing list
>> ros-users at code.ros.org
>> https://code.ros.org/mailman/listinfo/ros-users
> --
> Ingo Lütkebohle
> Bielefeld University
> http://www.techfak.uni-bielefeld.de/~iluetkeb/
> PGP Fingerprint 3187 4DEC 47E6 1B1E 6F4F  57D4 CD90 C164 34AD CE5B
> _______________________________________________
> ros-users mailing list
> ros-users at code.ros.org
> https://code.ros.org/mailman/listinfo/ros-users

More information about the ros-users mailing list