<div dir="ltr">A few of us have been experimenting with various schemes for rendering docs and tutorials as static versioned pages rather than wiki content, cf.<div><br></div><div><a href="http://docs.ros.org/api/jackal_tutorials/html/" target="_blank">http://docs.ros.org/api/jackal_tutorials/html/</a><br></div><div><a href="http://docs.ros.org/indigo/api/robot_upstart/html/" target="_blank">http://docs.ros.org/indigo/api/robot_upstart/html/</a><br></div><div><a href="http://docs.ros.org/indigo/api/capabilities/html/" target="_blank">http://docs.ros.org/indigo/api/capabilities/html/</a><br></div><div><a href="http://unboundedrobotics.github.io/ubr1_preview/" target="_blank">http://unboundedrobotics.github.io/ubr1_preview/</a></div><div><br></div><div>I was particularly happy with the sphinx-argparse plugin which is what <a href="http://docs.ros.org/indigo/api/robot_upstart/html/install.html">renders the first big chunk of this page</a>. I think there would be fantastic potential to develop a suite of Sphinx plugins which could automatically render decent quality docs from easily discoverable information (cfg files, launch files, etc).</div><div><br></div><div>William's got a more general discussion about where this should/could go in the future:</div><div><br></div><div><a href="http://design.ros2.org/articles/ros_documentation_system.html" target="_blank">http://design.ros2.org/articles/ros_documentation_system.html</a></div><div><br></div><div><br></div><div class="gmail_extra"><br><div class="gmail_quote">On 8 May 2015 at 11:16, Jonathan Bohren via ros-users <span dir="ltr"><<a href="mailto:ros-users@lists.ros.org" target="_blank">ros-users@lists.ros.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><div dir="ltr"><span><div>> Btw, Jonathan, congratulations  for your project. Is a cool idea and can be very helpful if everybody gets to know it.</div><div><br></div></span>Thanks, Jorge. And don't worry about not knowing about <a href="http://rosindex.github.io" target="_blank">rosindex</a>, I only made an announcement about on the mailing list a few months ago. <div><br></div><div>The nice thing about <a href="http://rosindex.github.io" target="_blank">rosindex</a> is that it's a completely statically-generated site, so it should respond much faster than the current ROS wiki. Also it doesn't rely on people to create wiki pages for packages. If a package has a README file, it's rendered right on the site. I hope to have some more time to hack on it this summer, and hopefully I'll be able to add in a source-based tutorial structure so tutorials can be versioned along with code.<div dir="ltr"><br><div><br></div><div>-j</div></div></div></div>
<br>_______________________________________________<br>
ros-users mailing list<br>
<a href="mailto:ros-users@lists.ros.org" target="_blank">ros-users@lists.ros.org</a><br>
<a href="http://lists.ros.org/mailman/listinfo/ros-users" target="_blank">http://lists.ros.org/mailman/listinfo/ros-users</a><br>
<br></blockquote></div><br></div></div>