renamed WITH_BF_BPYDOC to WITH_BF_DOCS, added SConscript for building BGE docs too.
This commit is contained in:
@@ -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')
|
||||
|
||||
|
||||
28
source/gameengine/PyDoc/SConscript
Normal file
28
source/gameengine/PyDoc/SConscript
Normal file
@@ -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)
|
||||
|
||||
@@ -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'),
|
||||
|
||||
|
||||
Reference in New Issue
Block a user