What's the current best practice to document the source code of a ROS2 (Bouncy, colcon build) Python package?
Originally posted by thinwybk on ROS Answers with karma: 468 on 2018-08-19
Post score: 0
1 Answer
$\begingroup$
$\endgroup$
See this answer.
Originally posted by Geoff with karma: 4203 on 2018-08-20
This answer was ACCEPTED on the original site
Post score: 0
Original comments
Comment by thinwybk on 2018-08-21:
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?
Comment by Geoff on 2018-08-21:
Any documentation tool can be used without limitations in your package.
