Skip to main content

History: How to build PyOgre documentation

View published page

Source of version: 2 (current)

Copy to clipboard
            Building PyOgre Documentation Tutorial
(This tutorial is based on this [http://www.ogre3d.org/phpBB2addons/viewtopic.php?t=40|forum post] by vgmdev)

{maketoc}

!!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:

{MONO()} 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{MONO}

!!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.__