[Documentation] [TitleIndex] [WordIndex

Epydoc

Epydoc is a tool for generating documentation for Python code. rosdoc_lite supports documenting packages with Epydoc. If you wish to learn more about Epydoc, please consult the official Epydoc documentation.

You don't need to configure and run Epydoc manually in order to generate documentation for your ROS package. Instead, we recommend that you use the rosdoc_lite tool, which can setup your Python path automatically and streamline other setup.

Note: Epydoc's "introspection" capability currently breaks when trying to process some ros python modules, so this feature should not be enabled in a custom epydoc config file.

See also: rosdoc_lite, Sphinx, Doxygen

Enabling Epydoc for a Package

There are a couple of steps you need to take in order to enable Epydoc to run on your ROS package with the rosdoc_lite tool.

Step 1: Create a rosdoc config file

Step 2: Add a <rosdoc> export to your Manifest

Step 3 (optional): Create an epydoc configuration file


2018-09-15 12:20