Recreating my GSoC branch.
[blender.git] / source / gameengine / PyDoc / how_to_build_win.txt
1 How To Build the BGE Documentation in Windows
2 -------------------------------------------------------------------------
3 1) download and install Python 2.6 - http://www.python.org
4 2) download and install Epydocs - http://epydoc.sourceforge.net
5
6 * 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.
7
8 3) creates a epy_docgen.bat file in this folder (source\gameengine\PyDoc\) and paste the following line into it:
9
10 ::::::
11 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
12 ::::::
13
14 4) run your created batch file. If everything goes well it creates a folder named BPY_GE with all the generated documentation.
15
16 Documentation valid in March of 2010 - Blender 2.5alpha2