= Developer Documentation = == Overview == The main developer documentation is now based on [http://sphinx.pocoo.org Sphinx] and is part of the code tree. See source:trunk/doc/. To build it first build ''asap''. After that go into the '''doc''' directory and type {{{ make html }}} This will create the html structure in '''doc/_build/html''' Alternative targets are also available (e.g. tex) == Coding Guidelines == * please follow PEP8 (style guide) when using python * python tests shall use nose for test running. * all new python classes/modules need a complimentary (nose-based) test in source:trunk/test e.g. '''python/newmodule.py''' -> '''test/test_newmodule.py'''. See existing ones for example. * after making changes and before checking in, please run {{{nosetests test/test_*.py}}} == Reference ==