Skip to main content

Sphinx extension to document ROS packages.

Project description

PyPi version PyPi downloads per month Documentation Status

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx-ros-0.1.tar.gz (7.4 MB view hashes)

Uploaded source

Built Distributions

sphinx_ros-0.1.0-py2-none-any.whl (10.8 kB view hashes)

Uploaded py2

sphinx_ros-0.1-py2-none-any.whl (10.8 kB view hashes)

Uploaded py2

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page