Metadata-Version: 2.1
Name: sphinx-ros
Version: 0.1.0
Summary: Sphinx extension to document ROS packages.
Home-page: http://sphinx-ros.readthedocs.io/
Author: M.J.W. Snippe
Author-email: maxsnippe@gmail.com
License: MIT
Project-URL: Issue tracker, https://github.com/max-sn/sphinx_ros/issues
Project-URL: Documentation, http://sphinx-ros.readthedocs.io/
Project-URL: Repository, https://github.com/max-sn/sphinx_ros/
Platform: linux
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Description-Content-Type: text/x-rst
Requires-Dist: Sphinx (>=1.8)
Requires-Dist: setuptools (>=20.7)
Requires-Dist: rospkg

sphinx_ros
==========

.. image:: https://img.shields.io/pypi/v/sphinx-ros
  :target: https://pypi.org/project/sphinx-ros/
  :alt: PyPi version

.. image:: https://img.shields.io/pypi/dm/sphinx-ros
  :target: https://pypi.org/project/sphinx-ros/
  :alt: PyPi downloads per month

.. image:: https://img.shields.io/readthedocs/sphinx-ros/latest
  :target: https://sphinx-ros.readthedocs.io/en/latest/
  :alt: 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 <http://www.sphinx-doc.org/>`_, 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 <http://sphinx-ros.readthedocs.io>`_ for more information.


