2. HowTo

2.1. Syntax Highlighting

You can highlight a ROS message file(.msg, .srv, .action) using default directives like code-block and literalinclude.

Example:

.. code-block:: rostype

   Header header # header
   geometry_msgs/Vector3 acc

.. literalinclude:: Message.msg
   :language: rostype

Result:

Header header # header
geometry_msgs/Vector3 acc

# comment
# header
Header header
# Counter
int8 counter 
# Position
geometry_msgs/Vector3 pos

2.2. Dirctives

.. ros:package:: package_name

This directive is to document package information by hand. If you have package.xml, you can use ros:autopackage instead. Following fields are supported. They are same as REP-127 .

  • version
  • description
  • maintainer
  • license
  • url
  • author
  • build_depend
  • buildtool_depend
  • build_export_depend
  • buildtool_export_depend
  • exec_depend
  • test_depend
  • doc_depend
  • conflict
  • replace
  • export

Example:

.. ros:package:: my_great_package

   :version: 1.0.0
   :description: This is a great package.
   :maintainer: John Smith
   :build_depend: :ros:pkg:`catkin`

Reulst:

my_great_package
Version:

1.0.0
Description:

This is a great package.
Maintainers:
  • John Smith
BuildDepends:
  • catkin

Following options are supported:

noindex
If this option is added, then the package object will not show in the indices.
.. ros:autopackage:: package_name

This directive generates package information document from package.xml.

Example:

.. ros:autopackage:: my_great_autopackage

Reulst:

my_great_autopackage

Following options are supported:

noindex
Same as noindex of ros:package.
base : path
Specify the ROS root path for the package.
.. ros:message:: package_name/MessageName
.. ros:automessage:: package_name/MessageName

This directive is to document package information from package.xml.

Example:

.. ros:autopackage:: my_great_autopackage

Reulst:

my_great_autopackage
noindex
Same as noindex of ros:package.
base : path
Specify the ROS root path for the package.
description : start:end, [quote]
TODO
field-comment : [up-all|up|right1|right-down|right-down-all] [quote]
TODO
raw : [head|tail]
TODO
.. ros:service:: package_name/ServiceName
.. ros:autoservice:: package_name/ServiceName
.. ros:action:: package_name/ActionName
.. ros:autoaction:: package_name/ActionName
.. ros:node:: package_name/NodeName

2.3. Roles

:ros:pkg:
:ros:msg:
:ros:srv:
:ros:action:

2.4. Configurations

ros_base_path = list of str