A few of us have been experimenting with various schemes for rendering docs and tutorials as static versioned pages rather than wiki content, cf.

http://docs.ros.org/api/jackal_tutorials/html/
http://docs.ros.org/indigo/api/robot_upstart/html/
http://docs.ros.org/indigo/api/capabilities/html/
http://unboundedrobotics.github.io/ubr1_preview/

I was particularly happy with the sphinx-argparse plugin which is what renders the first big chunk of this page. 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).

William's got a more general discussion about where this should/could go in the future:

http://design.ros2.org/articles/ros_documentation_system.html



On 8 May 2015 at 11:16, Jonathan Bohren via ros-users <ros-users@lists.ros.org> wrote:
> Btw, Jonathan, congratulations  for your project. Is a cool idea and can be very helpful if everybody gets to know it.

Thanks, Jorge. And don't worry about not knowing about rosindex, I only made an announcement about on the mailing list a few months ago. 

The nice thing about rosindex 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.


-j

_______________________________________________
ros-users mailing list
ros-users@lists.ros.org
http://lists.ros.org/mailman/listinfo/ros-users