[Documentation] [TitleIndex] [WordIndex

Sphinx

Sphinx is a tool for generating documentation for Python code. rosdoc supports documenting packages with Sphinx.

See also: rosdoc, Epydoc, Doxygen

Enabling Sphinx for a Package

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

Step 1: Create a rosdoc config file

This configuration will run Epydoc in the default configuration that rosdoc has specified.

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

Step 3: Install Sphinx on your system

Step 4: Create a Sphinx configuration file

Example

To be done...


2020-08-08 12:24