Documentation and regression testing

miyo · Post by **miyo** » February 1st, 2004, 9:07 pm

Jaramir hosts our Wiki. CyrilB hosts http://www.wesnoth.org, Ettin is webmaster for http://www.wesnoth.org, forum is provided by Dave. You can reach them using e.g. forum private messaging system - http://wesnoth.whitevine.net/forum/phpBB2/privmsg.php

All people use same nick in IRC and forum, except Dave whose nick in IRC is Sirp.

- Miyo

Post by **ettin** » February 1st, 2004, 10:24 pm

jacob wrote:On IRC, we discussed making the documentation available online, possibly building the documentation on the server with a cronjob.

As far as I know, we can't manage cron. Anyway, I'll ask CyrilB about that.

miyo · Post by **miyo** » February 2nd, 2004, 6:58 am

We can manage cron on e.g. devsrv.wesnoth.org (hosted by me) and then upload data.

- Miyo

jacob · Post by **jacob** » February 3rd, 2004, 2:20 am

miyo, as we discussed on IRC, I have checked in the current documentation to CVS. It can be built by executing 'doxygen' from the project root directory. The generated documentation will be in:

doc/doxygen/html

The script to be executed by cron could work like this:
1. Update local files via CVS
2. doxygen
3. Ftp all files in ./doc/doxygen/html to wesnoth.org.
4. rm -rf ./doc/doxygen/html

When building the documentation on devsrv, it is not necessary to update all of the project files. It could be done like this:

cvs -z3 -d:ext:anoncvs@savannah.nongnu.org:/cvsroot/wesnoth update wesnoth/Doxyfile wesnoth/src wesnoth/doc/doxygen

Note: the generated documentation currently takes up 6 MB. I will try to cut down on it. I feel updating the documentation once a day would be more than enough to keep the documentation mostly current.

Can PHP be used on wesnoth.org? The search feature use PHP, but does not have other dependencies like MySQL. I can turn it off if we cannot use PHP.

Let me know if you have any problems with this, and whether I should post a script for the cronjob.

miyo · Post by **miyo** » February 6th, 2004, 5:10 am

http://devdocs.wesnoth.org

docs are generated 05:05 and 17:05 every day and uploaded as soon as doxygen finishes building the documentation.

- Miyo

Post by **ettin** » February 6th, 2004, 6:53 am

jacob wrote:Can PHP be used on wesnoth.org? The search feature use PHP, but does not have other dependencies like MySQL. I can turn it off if we cannot use PHP.

Yes. PHP can be used on http://www.wesnoth.org.

jacob · Post by **jacob** » February 7th, 2004, 1:18 am

Thank you, miyo and ettin. Can a link be added to it from somewhere on wesnoth.org, so people will be able to find it?

miyo · Post by **miyo** » February 7th, 2004, 7:38 am

Ettin,

maybe under 'Project' in http://www.wesnoth.org?

- Miyo

Post by **ettin** » February 7th, 2004, 4:04 pm

miyo wrote:Ettin, maybe under 'Project' in http://www.wesnoth.org?

Yes, http://www.wesnoth.org/project.htm#devdocs