<div dir="ltr"><font><font face="tahoma,sans-serif"><font>Hi, <br><br><font>Thank<font>s for <font>all the hard work to imp<font>ro<font>ve the <font>documentation <font>system<font>.<br></font></font></font></font></font></font></font></font></font></font></font><br>
<blockquote style="margin:0px 0px 0px 0.8ex;border-left:1px solid rgb(204,204,204);padding-left:1ex" class="gmail_quote"><font><font face="tahoma,sans-serif"><font><font><font><font><font><font><font><font><font> For detailed instructions on how to add your packages to the index, please see this <a href="http://www.ros.org/wiki/Get%20Involved#Indexing_Your_.2A-ros-pkg_Repository_for_Documentation_Generation" target="_blank">page</a>, but it should be as simple as creating a rosinstall file for your stack, metapackage, or repository group.</font></font></font></font></font></font></font></font></font></font></font><br clear="all">
</blockquote><div><br>I think the information on this page (and similar pages) also needs to be updated:<br><br><a href="http://www.ros.org/wiki/Repositories/IndexSubmission">http://www.ros.org/wiki/Repositories/IndexSubmission</a><br>
<br>Best,<br>Mani<br></div><br><div class="gmail_quote">On Mon, Oct 22, 2012 at 6:00 PM, Eitan Marder-Eppstein <span dir="ltr"><<a href="mailto:eitan@hidof.com" target="_blank">eitan@hidof.com</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hey all,<div><br></div><div>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 <a href="http://ros.org/wiki/rosdoc_lite" target="_blank">http://ros.org/wiki/rosdoc_lite</a>.</div>
<div><br></div><div>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 <a href="http://ros.org" target="_blank">ros.org</a>, 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 <a href="http://www.ros.org/wiki/Get%20Involved#Indexing_Your_.2A-ros-pkg_Repository_for_Documentation_Generation" target="_blank">page</a>, but it should be as simple as creating a rosinstall file for your stack, metapackage, or repository group.</div>
<div><br></div><div>The new documentation also comes with updated wiki macros for generating package and stack headers on <a href="http://ros.org" target="_blank">ros.org</a>. 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: <a href="http://www.ros.org/wiki/WikiMacros" target="_blank">http://www.ros.org/wiki/WikiMacros</a>. Since they are backwards compatible, we've already switched the wiki over.</div>
<div><br></div><div>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 <a href="http://www.ros.org/wiki/Get%20Involved#Fuerte_and_later" target="_blank">here</a>.</div>
<div><br></div><div>Some useful pages:</div><div><br></div><div>Tickets for rosdoc_lite (<a href="https://github.com/ros-infrastructure/rosdoc_lite/issues" target="_blank">https://github.com/ros-infrastructure/rosdoc_lite/issues</a>)</div>
<div>Tickets for indexing system (<a href="https://github.com/ros-infrastructure/jenkins_scripts/issues" target="_blank">https://github.com/ros-infrastructure/jenkins_scripts/issues</a>)</div><div><br></div><div>Hope all is well,</div>
<div>
<br></div><div>Eitan</div><span class="HOEnZb"><font color="#888888"><div>
<div><br></div>-- <br>Eitan Marder-Eppstein<div>
President, hiDOF Inc.</div><div><a href="http://www.hidof.com" target="_blank">http://www.hidof.com</a></div><br>
</div>
</font></span><br>_______________________________________________<br>
ros-users mailing list<br>
<a href="mailto:ros-users@code.ros.org">ros-users@code.ros.org</a><br>
<a href="https://code.ros.org/mailman/listinfo/ros-users" target="_blank">https://code.ros.org/mailman/listinfo/ros-users</a><br>
<br></blockquote></div><br></div>