Building PyOgre Documentation Tutorial
(This tutorial is based on this forum post by vgmdev)
Table of contents
Step 1 - Download and install Doxygen
Download and install Doxygen
Step 2 - Create pyogre.cfg
In python24/lib/site-packages/pyogre create â€œpyogre.cfgâ€ with the following content: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
Step 3 - Run Doxywizard
Run Doxywizard, Load pyogre.cfg file and hit â€œStartâ€
You are going to get not documented warnings. But thatâ€™s ok for now.
The documentation can now be reached here: python24/lib/site-packages/pyogre/docs/html/index.html
And thatâ€™s it.