The software and firmware source code contains in-line 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:
firmware | openvisualizer |
---|---|
build docs | build docs |
publish docs | publish docs |
You can build the documentation locally on your computer, using an SCons target.
|
openwsn-fw/
.Enter the following command
scons docs |
openwsn-fw/build/docs
.index.html
to open the documentation:
Current documentation is built automatically and available from our github.io site.
You also may generate the documentation via SCons from the openvisualizer
directory, with the 'docs' target. All documentation templates (.rst files) are stored in the openvisualizer/docs
directory.
The pythonhosted site includes an excellent page on Sphinx formatting. See the "Full Code Example" section at the bottom of the page for docstring tags.