Development

Development dependencies

• CMocka (testing)

• Python and pip (Sphinx platform)

• Doxygen

• Sphinx (documentation)

• There are some Ruby scripts in misc

• Valgrind (memory correctness & profiling)

• GCOV/LCOV (test coverage)

Installing sphinx

pip install sphinx
pip install sphinx_rtd_theme
pip install breathe
pip install https://github.com/lepture/python-livereload/archive/master.zip
pip install sphinx-autobuild

Further instructions on configuring advanced features can be found at http://read-the-docs.readthedocs.org/en/latest/install.html.

Live preview of docs

cd doc
make livehtml

Set up git hooks

A git hook that automatically refereshes the GH pages contents located in docs can be symlinked:

ln -s misc/hooks/pre-commit .git/hooks

Testing and code coverage

Please refer to Tests