Sphinx扩展到文档ROS包。
sphinx-ros的Python项目详细描述
此扩展添加了可用于记录 ROS包。
用法
在conf.py文件中包含扩展名。如果你还没有分机, 使用:
extensions = ['sphinx_ros']
否则使用:
extensions.append('sphinx_ros')
这会将ros域添加到Sphinx,并且 允许您使用此扩展中定义的指令,例如。 .. ros:package::,.. ros:message::等。
一个简单的例子:
.. ros:package:: foo_bar_package .. ros:message:: foo :msg_param bar: The bar included in foo. :msg_paramtype bar: :ros:msg:`int16`
有关详细信息,请参见the docs。