How to document ROS2 Python package source code?

ros2
bouncy

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

thinwybk
428 ●51 ●68 ●75

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

add a comment

1 Answer

Sort by » oldest newest most voted

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

Geoff

3898 ●14 ●98 ●59

See this answer.

edit flag offensive delete link

Comments

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?