Automatically generate documentation for ROS nodes
Switch branches/tags
Nothing to show
Clone or download
mlauret and bponsler Fixed typo in documentation and usage (#1)
* Update README.md

Fixed typo in 'proxy-port' argument
Added rendered HTML doc with rawgit

* Update masterProxy.py

Fixed typo
Latest commit dbb6665 Oct 9, 2017

README.md

rosautodoc

The rosautodoc project provides a python executable that can automatically generate documentation for ROS nodes that are running on the system.

Why should I care?

This tool makes it possible to quickly generate initial documentation of the interface for a specific ROS node (or several nodes) based on how it performs at runtime. This eliminates the need to search through your code to make sure you document all the ROS parameters being used, or all the topics that your node is subscribing to. This script manages all of that for you -- you just need to fill in the descriptions of the API.

Installation

Follow these instructions to download and install this project:

git clone https://github.com/bponsler/rosautodoc
cd rosautodoc
sudo python setup.py install

How does this work?

The rosautodoc script creates a proxy server that stands between a ROS system and the ROS master to intercept all requests made by nodes. This allows the proxy server to keep track of all publishers, subscribers, parameters, and services used by each node and then use this information to create documentation for the node.

Usage

This section describes how to use this project to automatically generate documentation.

$ rosautodoc --help
usage: rosautodoc [-h] [--output-dir OUTPUT_DIR] [--proxy-port PROXY_PORT]
                  [--doc-format DOC_FORMAT]
                  [node [node ...]]

Automatically document the API for a ROS node.

positional arguments:
  node                  The name of the nodes to document. If empty, all nodes
                        will be documented

optional arguments:
  -h, --help            show this help message and exit
  --output-dir OUTPUT_DIR
                        The directory where documentation should be written
  --proxy-port PROXY_PORT
                        The port to use for the ROS master proxy server
  --doc-format DOC_FORMAT
                        The format of the documentation to generate (markdown,
                        html)

Examples

First, run the ROS master in one terminal (using the default master URI http://localhost:11311):

roscore

Next, run the auto doc script in another terminal:

mkdir /tmp/my_documentation
rosautodoc --proxy-port=33133 --output=/tmp/my_documentation

Finally, run your node in another terminal, and be sure to connect it to the same port that the rosautodoc script is using:

export ROS_MASTER_URI=http://localhost:33133
rosrun my_package my_node

Once your node has finished starting up, you can stop the rosautodoc process which will write one documentation file for every node on the system. The documentation will be located in the /tmp/my_documentation directory.

Alternatively, you can document only a specific node:

rosautodoc --proxy-port=33133 --output=/tmp/my_documentation /ns/my_node_name

The following command can be used to generate HTML documentation:

rosautodoc --proxy-port=33133 --doc-format=html --output=/tmp/my_documentation

This will generate an HTML documentation page for every node in your system and also a main index.html page that links to all the node documentation pages.

You can also generate documentation for only a specific set of nodes.

rosautodoc --proxy-port=33133 node1 node2 node3

This command will generated a markdown (the default documentation format) file for the three nodes provides: node1, node2, and node3. It will also generate a main README.md file that links to the individual node documentation pages.

Note that since the --output-dir argument was not provided, the documentation will be generated in the current working directory by defualt.

Example documentation

For example documentation view one of the following pages: