[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [17135] trunk/blender: renamed WITH_BF_BPYDOC to WITH_BF_DOCS, added SConscript for building BGE docs too.
Campbell Barton
ideasman42 at gmail.com
Tue Oct 21 01:21:01 CEST 2008
Revision: 17135
http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=17135
Author: campbellbarton
Date: 2008-10-21 01:21:01 +0200 (Tue, 21 Oct 2008)
Log Message:
-----------
renamed WITH_BF_BPYDOC to WITH_BF_DOCS, added SConscript for building BGE docs too.
Modified Paths:
--------------
trunk/blender/SConstruct
trunk/blender/tools/btools.py
Added Paths:
-----------
trunk/blender/source/gameengine/PyDoc/SConscript
Modified: trunk/blender/SConstruct
===================================================================
--- trunk/blender/SConstruct 2008-10-20 23:12:42 UTC (rev 17134)
+++ trunk/blender/SConstruct 2008-10-20 23:21:01 UTC (rev 17135)
@@ -577,6 +577,7 @@
# 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')
Added: trunk/blender/source/gameengine/PyDoc/SConscript
===================================================================
--- trunk/blender/source/gameengine/PyDoc/SConscript (rev 0)
+++ trunk/blender/source/gameengine/PyDoc/SConscript 2008-10-20 23:21:01 UTC (rev 17135)
@@ -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)
+
Modified: trunk/blender/tools/btools.py
===================================================================
--- trunk/blender/tools/btools.py 2008-10-20 23:12:42 UTC (rev 17134)
+++ trunk/blender/tools/btools.py 2008-10-20 23:21:01 UTC (rev 17135)
@@ -68,7 +68,7 @@
'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 @@
('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'),
More information about the Bf-blender-cvs
mailing list