Sphinx扩展到文档ROS包。

sphinx-ros的Python项目详细描述


PyPi versionPyPi downloads per monthDocumentation Status

此扩展添加了可用于记录 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

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
java Thumbnailator库将图像转换为cmyk   Java反射从目录中的类运行测试   JavaEclipseJDT编译器说方法未定义,但EclipseIDE没有   重构如何重构一行重复的java代码   java Eclipse:使用删除线文本呈现自定义注释   java问题与ArrayList复制数据   java如何在swagger中传递访问令牌?   使用另一个java文件运行java文件时出错   java为什么谷歌云存储生成的上传链接在成功上传后不会失效?   java将我的客户端PC重定向到默认登录页面   java hibernate c3p0配置mysql问题   java和java之间的区别。尼奥。文件文件和java。伊奥。文件   列出java循环并向映射中添加值   java为什么OJ报告这段代码的运行时错误?