vgmdev
01-10-2005 17:31:07
Building PyOgre Documentation Tutorial
Since pyogre does not have API Reference yet, I have made pyogre docs with doxygen. (This is my first time working with doxygen)
For Windows users:
1.Download doxyegn:
Page: http://www.stack.nl/~dimitri/doxygen/download.html
Windows Setup: ftp://ftp.stack.nl/pub/users/dimitri/do ... -setup.exe
2.In python24/lib/site-packages/pyogre Create “pyogre.cfg”
3.Run Doxywizard, Load pyogre.cfg file and hit “Start”
You are going to get not documented warnings. But that’s ok for now.
Run: python24/lib/site-packages/pyogre/docs/html/index.html
And that’s it.
Since pyogre does not have API Reference yet, I have made pyogre docs with doxygen. (This is my first time working with doxygen)
For Windows users:
1.Download doxyegn:
Page: http://www.stack.nl/~dimitri/doxygen/download.html
Windows Setup: ftp://ftp.stack.nl/pub/users/dimitri/do ... -setup.exe
2.In python24/lib/site-packages/pyogre Create “pyogre.cfg”
PROJECT_NAME = "PyOgre - An OGRE Binding for Python"
OUTPUT_DIRECTORY = docs
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
INPUT = ogre.py
QUIET = YES
JAVADOC_AUTOBRIEF = YES
3.Run Doxywizard, Load pyogre.cfg file and hit “Start”
You are going to get not documented warnings. But that’s ok for now.
Run: python24/lib/site-packages/pyogre/docs/html/index.html
And that’s it.