Add Doxygen documentation to GitLab
Created by: joansola
Hi. This for the experts and curious.
There is a way to have the Doxygen doc available in GitHub. Though we really need it, I have to say that it is not ideal:
- we need to run Doxygen ourselves from one of our computers, and push the results to GitHub
this means that the doc will not necessarily be up-to-date. We need to run doxygen and push on a regular basis. I can do this, no problem.
As everything else in this XXI century, the procedure is somewhat technical and I wanted you to look at it and see if we want to do it. Basically, it is recommended to have a super-project with two projects as branches, so that we can checkout them independently, but have them together anyway. This is so (I think, but maybe I understood it wrongly) because we want at all times that the documentation reflects the state of the branch master, and not the others. Because @andreucm likes GitHub superprojects so much, here is to you.
I attach two links explaining the whys and hows:
http://rickfoosusa.blogspot.com.es/2011/10/howto-use-doxygen-with-github.html https://gist.github.com/chrisjacob/825950
I'll be setting up a Wolf meeting for next week, where we can discuss this alongside the migration to GitLab. Obviously, we want all this to integrate into GitLab! @artivis, will you be able to come?