Added small script to generate function cross reference with epydoc

This commit is contained in:
gergely.erdelyi 2008-06-25 21:03:38 +00:00
parent 04af0d20f5
commit a33eeef018
2 changed files with 27 additions and 1 deletions

View File

@ -104,7 +104,8 @@ SRCDIST_MANIFEST = [
"swig/typeinf.i",
"swig/ua.i",
"swig/xref.i",
"patches/ida51.patch"
"patches/ida51.patch",
"tools/gendocs.py",
]
# Temporaty build files to remove

25
tools/gendocs.py Normal file
View File

@ -0,0 +1,25 @@
#------------------------------------------------------------
# gendoc.py: Generate an API cross-reference for IDAPython
#------------------------------------------------------------
__author__ = "Gergely Erdelyi <dyce@d-dome.net>"
import epydoc.cli
# This is a small hack to prevent epydoc from exiting the whole
# IDA process in case something goes wrong.
def exit(eval):
print "not exiting"
epydoc.cli.sys.exit = exit
# Fill in the command-line arguments
epydoc.cli.optparse.sys.argv = [ 'epydoc',
'--no-sourcecode',
'-u', 'http://www.d-dome.net/idapython/',
'--navlink', '<a href="http://www.d-dome.net/idapython/reference/">IDAPython Reference</a>',
'--no-private',
'--simple-term',
'-o', 'idapython-reference-%d.%d.%d' % (IDAPYTHON_VERSION[:3]),
'--html',
'idc', 'idautils', 'idaapi' ]
# Generate the documentation
epydoc.cli.cli()