Code documentation¶

As you already know we can all benefit from good documentation. We have decided to try Sphinx for generating HTML-documentation from doc strings. You can find sample documentation for some of the hardware objects here.

The markup is very simple and will keep the doc strings readable in the console. Try to keep the documentation concise and thorough. The example above is far from finished but illustrates the result.