renamed WITH_BF_BPYDOC to WITH_BF_DOCS, added SConscript for building BGE docs too.
authorCampbell Barton <ideasman42@gmail.com>
Mon, 20 Oct 2008 23:21:01 +0000 (23:21 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Mon, 20 Oct 2008 23:21:01 +0000 (23:21 +0000)
SConstruct
source/gameengine/PyDoc/SConscript [new file with mode: 0644]
tools/btools.py

index f15aa8bfa2241d65e442d44cf5be4b2b3a65c835..48115a39b1d659b2a5cb91c66f7065fd43847b7e 100644 (file)
@@ -577,6 +577,7 @@ if not env['WITHOUT_BF_INSTALL']:
 # TODO: build stubs and link into blenderplayer
 
 #------------ EPYDOC
-if env['WITH_BF_BPYDOC']:
-    SConscript(['source/blender/python/api2_2x/doc/SConscript'])
+if env['WITH_BF_DOCS']:
+    SConscript('source/blender/python/api2_2x/doc/SConscript')
+    SConscript('source/gameengine/PyDoc/SConscript')
 
diff --git a/source/gameengine/PyDoc/SConscript b/source/gameengine/PyDoc/SConscript
new file mode 100644 (file)
index 0000000..3d1aa66
--- /dev/null
@@ -0,0 +1,28 @@
+#!/usr/bin/python
+Import ('env')
+
+
+from optparse import OptionParser
+try:
+    import epydoc
+except ImportError:
+    print "No epydoc install detected, Python API Docs will not be generated "
+if epydoc:
+    from epydoc.docbuilder import build_doc_index
+    from epydoc import cli
+    names = env.Glob("source/gameengine/PyDoc/*.py")
+    docindex = build_doc_index(names)
+    optvalues = cli.OPTION_DEFAULTS
+    optvalues["verbose"] = 1
+    optvalues["target"] = env["BF_DOCDIR"]+"/BGE_API/"
+    optvalues["url"] = "http://www.blender.org"
+    optvalues["top"] = "Game Engine API"
+    optvalues["name"] = "Blender"
+    optvalues["noprivate"] = 1
+    optvalues["noframes"] = 1
+    optvalues["names"] = names
+    optparser = OptionParser()
+    optparser.set_defaults(**optvalues)
+    (options, args) = optparser.parse_args()
+    cli.write_html(docindex, options)
+
index 9db7d48cc9821f992df8b69f0517d3df66af62ae..3112e61918a13af8ae0335bf4249481e49e9a0b7 100755 (executable)
@@ -68,7 +68,7 @@ def validate_arguments(args, bc):
             'BF_FANCY', 'BF_QUIET',
             'BF_X264_CONFIG',
             'BF_XVIDCORE_CONFIG',
-            'WITH_BF_BPYDOC',
+            'WITH_BF_DOCS',
             ]
 
     arg_list = ['BF_DEBUG', 'BF_QUIET', 'BF_CROSS', 'BF_UPDATE',
@@ -353,7 +353,7 @@ def read_opts(cfg, args):
 
         ('BF_X264_CONFIG', 'configuration flags for x264', ''),
         ('BF_XVIDCORE_CONFIG', 'configuration flags for xvidcore', ''),
-        (BoolOption('WITH_BF_BPYDOC', 'Generate BPY API documentation', 'false')),
+        (BoolOption('WITH_BF_DOCS', 'Generate API documentation', 'false')),
         
         ('BF_CONFIG', 'SCons python config file used to set default options', 'user_config.py'),