Attention: Answers.ros.org is deprecated as of August the 11th, 2023. Please visit robotics.stackexchange.com to ask a new question. This site will remain online in read-only mode during the transition and into the foreseeable future. Selected questions and answers have been migrated, and redirects have been put in place to direct users to the corresponding questions on Robotics Stack Exchange. Additional details are available here.

How to document ROS2 Python package source code?

ros2
bouncy

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

thinwybk
468 ●54 ●69 ●75

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

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 -0500

Geoff

4203 ●18 ●103 ●63

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?