DiArc Documentation!

Building

Building the Documentation

First you need sphinx installed, on Ubuntu:

$ sudo apt-get install python-sphinx

On other platforms use pip:

$ sudo pip install Sphinx

You have to have built the package first, then you mush source the resulting devel or install space:

$ source /path/to/space/setup.bash

Then from the capabilities source folder you can build the docs:

$ cd docs
$ make html

The resulting docs will be generated to doc/.build/html/index.html.

Running the Tests

Running the Code

Indices and tables

• Index
• Module Index
• Search Page