How to build PyOgre documentation

From Ogre Wiki

Building PyOgre Documentation Tutorial (This tutorial is based on this forum post by vgmdev)

Step 1 - Download and install Doxygen

Download and install Doxygen

Page: http://www.stack.nl/~dimitri/doxygen/download.html

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.