archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity

Added a message when people try build docs outside of blender

Browse Source
This commit is contained in:
Campbell Barton
2009-04-07 23:22:20 +00:00
parent 654a30aa2d
commit c80133e1bc
1 changed files with 20 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
source/blender/python/epy_doc_gen.py
View File

@@ -18,13 +18,16 @@
#
# #**** END GPL LICENSE BLOCK #****
# Usage,
# run this script from blenders root path once you have compiled blender
# ./blender.bin -b -P source/blender/python/epy_doc_gen.py
#
# This will generate rna.py, generate html docs by running...
# epydoc source/blender/python/doc/rna.py -o source/blender/python/doc/html -v --no-sourcecode --name="RNA API" --url="http://brechtvanlommelfanclub.com" --graph=classtree
#
script_help_msg = '''
Usage,
run this script from blenders root path once you have compiled blender
./blender.bin -P source/blender/python/epy_doc_gen.py
This will generate rna.py, generate html docs by running...
epydoc source/blender/python/doc/rna.py -o source/blender/python/doc/html -v --no-sourcecode --no-sourcecode --graph=classtree
epydoc source/blender/python/doc/bpyoperator.py -o source/blender/python/doc/html -v --no-sourcecode --no-sourcecode --graph=classtree
'''
# if you dont have graphvis installed ommit the --graph arg.
def range_str(val):
@@ -451,6 +454,14 @@ def op2epy(target_path):
out.close()
if __name__ == '__main__':
rna2epy('source/blender/python/doc/rna.py')
op2epy('source/blender/python/doc/bpyoperator.py')
if 'bpy' not in dir():
print "\nError, this script must run from inside blender."
print script_help_msg
else:
rna2epy('source/blender/python/doc/rna.py')
op2epy('source/blender/python/doc/bpyoperator.py')
import sys
sys.exit()