ROS Resources: Documentation | Support | Discussion Forum | Index | Service Status | ros @ Robotics Stack Exchange
Ask Your Question

How to document ROS2 Python package source code?

asked 2018-08-19 13:29:30 -0600

thinwybk gravatar image

updated 2018-08-20 01:22:46 -0600

What's the current best practice to document the source code of a ROS2 (Bouncy, colcon build) Python package?

edit retag flag offensive close merge delete

1 Answer

Sort by » oldest newest most voted

answered 2018-08-20 20:01:20 -0600

Geoff gravatar image
edit flag offensive delete link more


In addition to my comments in the referenced answer: The sphinx extensions should be usable without limitations, right? Means the non-default docstring styles (NumPy, Google) should be supported via napoleon. Autogeneration via sphinx-apidoc should be usable as well. Right?

thinwybk gravatar image thinwybk  ( 2018-08-21 01:53:18 -0600 )edit

Any documentation tool can be used without limitations in your package.

Geoff gravatar image Geoff  ( 2018-08-21 16:41:59 -0600 )edit

Question Tools



Asked: 2018-08-19 13:29:30 -0600

Seen: 228 times

Last updated: Aug 20 '18