forked from bartvdbraak/blender
17 lines
1.1 KiB
Plaintext
17 lines
1.1 KiB
Plaintext
|
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
|