mirrors/z3
3
0
Fork 0
mirror of https://github.com/Z3Prover/z3 synced 2025-04-15 13:28:47 +00:00
Code Activity

mk_doc.py --> mk_api_doc.py

Browse source 
Signed-off-by: Leonardo de Moura <leonardo@microsoft.com>
This commit is contained in:
Leonardo de Moura 2012-11-22 10:21:49 -08:00
parent badb81998d
commit 0111918aff
2 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/README
View file

@ -3,7 +3,7 @@ API documentation
To generate the API documentation for the C, .NET and Python APIs, we must execute To generate the API documentation for the C, .NET and Python APIs, we must execute
python mk_doc.py python mk_api_doc.py
We must have doxygen installed in our system. We must have doxygen installed in our system.

10
doc/mk_doc.py → doc/mk_api_doc.py
View file

@ -21,7 +21,7 @@ def cleanup_API(inf, outf):
_outf.write(line) _outf.write(line)
try: try:
mk_dir('html') mk_dir('api/html')
cleanup_API('../src/api/z3_api.h', 'z3_api.h') cleanup_API('../src/api/z3_api.h', 'z3_api.h')
print "Removed annotations from z3_api.h." print "Removed annotations from z3_api.h."
DEVNULL = open(os.devnull, 'wb') DEVNULL = open(os.devnull, 'wb')
@ -33,15 +33,15 @@ try:
print "Generated C and .NET API documentation." print "Generated C and .NET API documentation."
os.remove('z3_api.h') os.remove('z3_api.h')
print "Removed temporary file z3_api.h." print "Removed temporary file z3_api.h."
shutil.copy('z3.css', 'html/z3.css') shutil.copy('z3.css', 'api/html/z3.css')
print "Copied z3.css." print "Copied z3.css."
shutil.copy('z3.png', 'html/z3.png') shutil.copy('z3.png', 'api/html/z3.png')
print "Copied z3.png." print "Copied z3.png."
sys.path.append('../src/api/python') sys.path.append('../src/api/python')
pydoc.writedoc('z3') pydoc.writedoc('z3')
shutil.move('z3.html', 'html/z3.html') shutil.move('z3.html', 'api/html/z3.html')
print "Generated Python documentation." print "Generated Python documentation."
print "Documentation was successfully generated at subdirectory './html'." print "Documentation was successfully generated at subdirectory './api/html'."
except: except:
print "ERROR: failed to generate documentation" print "ERROR: failed to generate documentation"
exit(1) exit(1)