diff options
| author | Nathan Letwory <nathan@letworyinteractive.com> | 2008-10-20 02:01:46 +0400 |
|---|---|---|
| committer | Nathan Letwory <nathan@letworyinteractive.com> | 2008-10-20 02:01:46 +0400 |
| commit | f1f27c0350bbff1aa7f444f75eab294dd6b78e16 (patch) | |
| tree | 2abbd1bab0ed7b39be2fd458ac807cce3f570223 /tools/btools.py | |
| parent | 3544a4bd366c98bd5e514c7637ce0b1a369b6282 (diff) | |
=== SCons ===
[#17867] Adds option to SCONS to generate Python API documentation
Added patch from Brandano with some small improvements (BF_DOCDIR, clean) by yours truly.
To use make sure you have epydoc installed. Enable with WITH_BF_BPYDOC=1.
Diffstat (limited to 'tools/btools.py')
| -rwxr-xr-x | tools/btools.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/tools/btools.py b/tools/btools.py index 04ff9bcd914..9db7d48cc98 100755 --- a/tools/btools.py +++ b/tools/btools.py @@ -68,6 +68,7 @@ def validate_arguments(args, bc): 'BF_FANCY', 'BF_QUIET', 'BF_X264_CONFIG', 'BF_XVIDCORE_CONFIG', + 'WITH_BF_BPYDOC', ] arg_list = ['BF_DEBUG', 'BF_QUIET', 'BF_CROSS', 'BF_UPDATE', @@ -75,7 +76,8 @@ def validate_arguments(args, bc): 'BF_BUILDDIR', 'BF_FANCY', 'BF_QUICK', 'BF_PROFILE', 'BF_DEBUG_FLAGS', 'BF_BSC', 'BF_CONFIG', 'BF_PRIORITYLIST', 'BF_BUILDINFO','CC', 'CXX', 'BF_QUICKDEBUG', - 'BF_LISTDEBUG', 'LCGDIR', 'BF_X264_CONFIG', 'BF_XVIDCORE_CONFIG'] + 'BF_LISTDEBUG', 'LCGDIR', 'BF_X264_CONFIG', 'BF_XVIDCORE_CONFIG', + 'BF_DOCDIR'] all_list = opts_list + arg_list okdict = {} @@ -335,6 +337,7 @@ def read_opts(cfg, args): ('BF_BUILDDIR', 'Build dir', ''), ('BF_INSTALLDIR', 'Installation dir', ''), + ('BF_DOCDIR', 'Dir where BPy documentation will be created', ''), ('CC', 'C compiler to use', ''), ('CXX', 'C++ compiler to use', ''), @@ -350,6 +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')), ('BF_CONFIG', 'SCons python config file used to set default options', 'user_config.py'), |