Source Documentation
We use Sphinx for source documentation. Current The software and firmware source code contains in-line documentation:
- The OpenVisualizer is documented using Sphinx.
- The Firmware is documented using doxygen.
Consult documentation
The documentation is built nightly and published at http://openwsn-berkeley.github.io/.
Publication is done using the following job on the OpenWSN builder:
Build documentation
You can build the documentation locally on your computer, using an SCons target.
firmware
Info | ||
---|---|---|
| ||
|
- Using the command line, navitage to
openwsn-fw/
. Enter the following command
Code Block scons docs
- The documentation is created in
openwsn-fw/build/docs
. - Double-click on
index.html
to open the documentation:
Source Documentation
Current documentation is built automatically and available from our github.io site.
...