From 77f55d9cb3b92f0822cc8270904f48f6b0a448b3 Mon Sep 17 00:00:00 2001 From: Dalai Felinto Date: Tue, 30 Mar 2010 06:37:44 +0000 Subject: BGE API DOC: a guide on how to build epydoc for windows We have already a .sh file to build epydocs from Linux, so why not to have it in Windows as well ;) I think that this guide can help people interested in help with the API documentation to test their work. I'm actually already in touch with at least one volunteer helping with PhysicsConstraints module. VideoTexture may not be a one man job though, for I hope this document can also help. --- source/gameengine/PyDoc/how_to_build_win.txt | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 source/gameengine/PyDoc/how_to_build_win.txt (limited to 'source/gameengine/PyDoc') diff --git a/source/gameengine/PyDoc/how_to_build_win.txt b/source/gameengine/PyDoc/how_to_build_win.txt new file mode 100644 index 00000000000..018a28a9bfd --- /dev/null +++ b/source/gameengine/PyDoc/how_to_build_win.txt @@ -0,0 +1,16 @@ +How To Build the BGE Documentation in Windows +------------------------------------------------------------------------- +1) download and install Python 2.6 - http://www.python.org +2) download and install Epydocs - http://epydoc.sourceforge.net + +* for the following lines we will assume that your installation of Python is in C:\Python26 and epydocs is installed in the default folder Scripts\epydoc. + +3) creates a epy_docgen.bat file in this folder (source\gameengine\PyDoc\) and paste the following line into it: + +:::::: +C:\Python26\python.exe C:\Python26\Scripts\epydoc.py --debug -v -o BPY_GE --url "http://www.blender.org" --top API_intro --name "Blender GameEngine" --no-private --no-sourcecode --inheritance=included *.py ../../../source/blender/python/api2_2x/doc/BGL.py ../../../source/blender/python/api2_2x/doc/Mathutils.py ../../../source/blender/python/api2_2x/doc/Geometry.py +:::::: + +4) run your created batch file. If everything goes well it creates a folder named BPY_GE with all the generated documentation. + +Documentation valid in March of 2010 - Blender 2.5alpha2 \ No newline at end of file -- cgit v1.2.3