Dear developers, I set up the sphinx documentation for Phatch development. I've arranged in such way that the sphinx documentation gets fully automated, so you can't work in the rst files. If you want to generate documentation on your own computer, you need to install Sphinx 0.6.2 (or greater, note this is newer than in ubuntu repositories!).
So the steps to add documentation are: 1) in the python source code add docstrings, which contain all the parameters and their types. Also add doctests where possible. 2) In the docs folder you run the 'update.py' 3) Open docs/index.html All the code should switch to PEP8. Several source files have been converted already. Just put a '# Follows PEP8' command in your source file and run the script tests/pep8.py Afterwards fix the issues. Before contributing patches should run this test. Non PEP8 code will be refused. To run the doctests, install nose and run doc/tests. Before committing new code all tests should pass. Please start adding documentation and doctests to all the code you've contributed. This will be some work, but it will pay of. I hope to count on you! Best regards, Stani -- Phatch Photo Batch Processor - http://photobatch.stani.be SPE Python IDE - http://pythonide.stani.be
_______________________________________________ Mailing list: https://launchpad.net/~phatch-dev Post to : [email protected] Unsubscribe : https://launchpad.net/~phatch-dev More help : https://help.launchpad.net/ListHelp
