Documentation

[antsouchlos]

In order not to have to write documentation for each and every function of the public API by hand, I propose using SPHINX. What do you think, @philsegeler ?

[philsegeler]

This is actually not a bad idea at all! Do we need doxygen as well or can it work as is for parsing code comments?

Also where will we host it? Do we need to? Or do we just have to put instructions on how to generate the documentation?

[antsouchlos]

We will need to set up a doxygen project as well: https://stackoverflow.com/questions/11246637/using-sphinx-apidoc-to-generate-documentation-from-c-code

For starters I would just provide instructions on generating the documentation. Once the whole API gets to a properly usable point, where we might need to consult the documentation once in a while in order to create a game with the engine, we can think about hosting it.

I might even know a server we can host it, once we need to :D