GSoC/GCI Archive
Google Code-in 2013 Copyleft Games

PySoy: Docs Building in WAF

completed by: Darriel

mentors: Arc Riley

Currently we can only build docs using, but its currently the only task that we absolutely need for (everything else is WAF). Add a wscript_build to our docs directory and appropriate code in wscript/etc to build our docs as an automatic second step after normal building is done.

On the surface this is a 4-5 line task, however, our current use of ./ build_docs does not rebuild docs which have changed but instead requires that we remove docs/build to force an update. This problem may be just distutils stupidity which Waf will clean up automatically (the Waf tool should be building docs in build/docs anyway) or it may be an issue with Sphinx that needs deeper inspection.

If the problem is deeper, identify it and at least write a quick hack to address it (eg, always rebuild all docs regardless to whether any have changed) though a more elegant solution is obviously preferred.

While working on this task you should join and remain in #PySoy on Freenode to get help, feedback, and guidance from mentors and other developers. Code updates which may affect your work are also announced here as they happen.

When you've done, commit your work and post the resulting changeset url to this task.