sphinx-ros 0.1.0rc0

Sphinx extension to document ROS packages.

This extension adds reStructuredText directives that can be used to document ROS packages.

Usage

Include the extension in your conf.py file. If you have no extensions yet, use:

extensions = ['sphinx_ros']

Otherwise use:

extensions.append('sphinx_ros')

This adds the ros domain to Sphinx, and allows you to use the directives defined in this extension, e.g. .. ros:package::, .. ros:message:: et cetera.

A minimal example:

.. ros:package:: foo_bar_package

.. ros:message:: foo

  :msg_param bar: The bar included in foo.
  :msg_paramtype bar: :ros:msg:`int16`

See the docs for more information.