Documentation and regression testing
Moderator: Forum Moderators
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
All people use same nick in IRC and forum, except Dave whose nick in IRC is Sirp.
- Miyo
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.
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.
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
docs are generated 05:05 and 17:05 every day and uploaded as soon as doxygen finishes building the documentation.
- Miyo
Yes. PHP can be used on http://www.wesnoth.org.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, http://www.wesnoth.org/project.htm#devdocsmiyo wrote:Ettin, maybe under 'Project' in http://www.wesnoth.org?