forked from bartvdbraak/blender
Scons epydos changed options
- no source code since this is only useful if the epydocs contain code, ours are only docstrings. - set inheritance to included so you dont have to search up the classes to find available functions. - SConstruct, isolate the exception for importing epydoc. - Added a print to the SConscript files otherwise it looks like nothings happening.
This commit is contained in:
parent
fcdbbee208
commit
9078ce5da2
@ -616,11 +616,13 @@ if not env['WITHOUT_BF_INSTALL']:
|
||||
|
||||
#------------ EPYDOC
|
||||
if env['WITH_BF_DOCS']:
|
||||
try:
|
||||
import epydoc
|
||||
try: import epydoc
|
||||
except: epydoc = None
|
||||
|
||||
if epydoc:
|
||||
SConscript('source/blender/python/api2_2x/doc/SConscript')
|
||||
SConscript('source/gameengine/PyDoc/SConscript')
|
||||
except ImportError:
|
||||
else:
|
||||
print "No epydoc install detected, Python API and Gameengine API Docs will not be generated "
|
||||
|
||||
|
||||
|
@ -10,6 +10,10 @@ names = env.Glob("source/blender/python/api2_2x/doc/[A-Z]*.py")
|
||||
docindex = build_doc_index(names)
|
||||
optvalues = cli.OPTION_DEFAULTS
|
||||
optvalues["verbose"] = 1
|
||||
optvalues["quiet"] = 0
|
||||
optvalues["include_source_code"] = 0
|
||||
optvalues["inheritance"] = "included"
|
||||
optvalues["show_private"] = 0
|
||||
optvalues["target"] = env["BF_DOCDIR"]+"/BPY_API/"
|
||||
optvalues["url"] = "http://www.blender.org"
|
||||
optvalues["top"] = "API_intro"
|
||||
@ -20,5 +24,6 @@ optvalues["names"] = names
|
||||
optparser = OptionParser()
|
||||
optparser.set_defaults(**optvalues)
|
||||
(options, args) = optparser.parse_args([])
|
||||
print "Writing Blender Python epydocs to \"%s\"" % optvalues["target"]
|
||||
cli.write_html(docindex, options)
|
||||
|
||||
|
@ -10,6 +10,10 @@ names = env.Glob("source/gameengine/PyDoc/*.py")
|
||||
docindex = build_doc_index(names)
|
||||
optvalues = cli.OPTION_DEFAULTS
|
||||
optvalues["verbose"] = 1
|
||||
optvalues["quiet"] = 0
|
||||
optvalues["include_source_code"] = 0
|
||||
optvalues["inheritance"] = "included"
|
||||
optvalues["show_private"] = 0
|
||||
optvalues["target"] = env["BF_DOCDIR"]+"/BGE_API/"
|
||||
optvalues["url"] = "http://www.blender.org"
|
||||
optvalues["top"] = "Game Engine API"
|
||||
@ -20,5 +24,6 @@ optvalues["names"] = names
|
||||
optparser = OptionParser()
|
||||
optparser.set_defaults(**optvalues)
|
||||
(options, args) = optparser.parse_args([])
|
||||
print "Writing Game Engine epydocs to \"%s\"" % optvalues["target"]
|
||||
cli.write_html(docindex, options)
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user