Doxygen documentation for all the SSS projects will go here when I get the doxygentrac plugin working
- Fountain documentation
- SSSCommander documentation
- Bamboo Library documentation
Comment by mekstran on Sat Mar 25 10:08:18 2006
Since Trac is served up through CGI, viewing Doxygen documentation through is noticibly slow and puts a fair amount of load on the server (just me doing a bit of browsing gives the server a last-minute load average of 0.34).
I propose we just set up a directory that's served up by Apache itself, put the docs, there, and link from Trac to that directory as appropriate. We could even frame it with a link back to Trac, if we want.
Additionally, the Doxygen Trac plugin just pulls in the entire HTML file without doing any parsing - this results in a page with nested HTML elements, highly invalid.
Thoughts?
I've played a bit with trying to get Apache to intercept /trac/doxygen requests, to no avail.
Comment by mekstran on Sat Mar 25 10:10:47 2006
OK, so the invalid HTML thing can be fixed by using alternate Doxygen templates. Just found that on a bit of a Google search. (Should have figured that could be done, but oh well).
I still think it'd be good if we get the Doxygen served by Apache itself.
Comment by samm on Sat Mar 25 11:54:25 2006
yeah i'm not too pleased with this doxygen plugin. It's a giant hack to start with and I had to change quite a bit of the code to get it to work in our environment. I think we should ditch it and just link to the documentation in a separate directory as you proposed.
Comment by mekstran on Sat Mar 25 12:12:37 2006
You may want to use my doxyrun script to build your docs - it runs Doxygen, and then, if you have specified --rsync on the command line, uses rsync to copy the docs to wherever you specify. So you can rebuild the docs and upload them to the server in one step.
Comment by mekstran on Sat Mar 25 15:11:15 2006
There, the /doxygen directory is created and the pages link out to it.
