Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2009-04-20 02:02:48 +0400
committerCampbell Barton <ideasman42@gmail.com>2009-04-20 02:02:48 +0400
commit9078ce5da209bcfd31c60b55118076359ce7244f (patch)
tree2a857aec01b1182d3c0752c35364ac70bc5fa9cf
parentfcdbbee208fb64e9f0696843a69726de3c0d36b8 (diff)
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.
-rw-r--r--SConstruct8
-rw-r--r--source/blender/python/api2_2x/doc/SConscript5
-rw-r--r--source/gameengine/PyDoc/SConscript5
3 files changed, 15 insertions, 3 deletions
diff --git a/SConstruct b/SConstruct
index 3cdb5aeace7..03aee18413c 100644
--- a/SConstruct
+++ b/SConstruct
@@ -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 "
diff --git a/source/blender/python/api2_2x/doc/SConscript b/source/blender/python/api2_2x/doc/SConscript
index 4e2c72ba502..c95b844c1f4 100644
--- a/source/blender/python/api2_2x/doc/SConscript
+++ b/source/blender/python/api2_2x/doc/SConscript
@@ -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)
diff --git a/source/gameengine/PyDoc/SConscript b/source/gameengine/PyDoc/SConscript
index ab1fda8fa85..ed9712ba273 100644
--- a/source/gameengine/PyDoc/SConscript
+++ b/source/gameengine/PyDoc/SConscript
@@ -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)