Documentation

I have looked at sphinx as a way to document our python code.

I quite liked it as it has html output. Once uploaded a python package on pypi you can also host the HTML documentation on pythonhosted.

Writing the sphinx markup seems way less complicated than latex.

And we could think about writing the C++ documentation in sphinx too.

As we planned some time dedicated to documentation in our project we should decide for a cool tool.

You can check out the sample documentation in the branch feature/sphinx_doc. Install sphinx pip install Sphinx and run make html or make latexpdf in our doc/sphinx folder.

The result will be in the builddir.

I think the website looks quite nice and there is enough (far not as flexible as latex of course) markup available to write a nice looking doc.