gammapy/ringtophat — Issue #2: How to generate the documentation?
Author: cdeil
Created: 2012-02-24 14:21:06+00:00
State: open

The most popular documentation systems are doxygen [1] for C / C++ and Sphinx [2] for python.
I have never used either on a combined C / C++ and python project, we should check out both (and possibly other projects) to see if we can get nice API and high-level user documentation for C / C++ and python.

We could use readthedocs [3] to auto-generate and host our documentation, it is super-simple and I've done this already for enrico [4].

[1] http://doxygen.org/
[2] http://sphinx.pocoo.org/
[3] http://readthedocs.org/
[4] http://enrico.readthedocs.org/