| | 1 | = Developer Documentation = |
| | 2 | |
| | 3 | == Overview == |
| | 4 | |
| | 5 | The main developer documentation is now based on [http://sphinx.pocoo.org Sphinx] and is part of the code tree. See source:trunk/doc/. |
| | 6 | To build it first build ''asap''. |
| | 7 | After that go into the '''doc''' directory and type |
| | 8 | {{{ |
| | 9 | make html |
| | 10 | }}} |
| | 11 | This will create the html structure in '''doc/_build/hmtl''' |
| | 12 | Alternative targets are also available (e.g. tex) |
| | 13 | |
| | 14 | |
| | 15 | == Coding Guidelines == |
| | 16 | |
| | 17 | * please follow PEP8 (style guide) when using python |
| | 18 | * python tests shall use nose for test running. |
| | 19 | * all new python classes/modules need a complimentary (nose-based) test in source:trunk/test e.g. |
| | 20 | '''python/newmodule.py''' -> '''test/test_newmodule.py'''. See existing ones for example. |
| | 21 | * after making changes and before checking in, please run |
| | 22 | {{{nosetests test/test_*.py}}} |
| | 23 | |
| | 24 | |
| | 25 | |
| | 26 | == Reference == |
