##// END OF EJS Templates
Merging upstream.
Merging upstream.

File last commit:

r2339:eb010065
r2340:ef5de34e merge
Show More
autogen_api.py
43 lines | 1.8 KiB | text/x-python | PythonLexer
Fernando Perez
Update docs for automatic API building.
r1850 #!/usr/bin/env python
"""Script to auto-generate our API docs.
"""
# stdlib imports
import os
import sys
# local imports
sys.path.append(os.path.abspath('sphinxext'))
from apigen import ApiDocWriter
#*****************************************************************************
if __name__ == '__main__':
pjoin = os.path.join
package = 'IPython'
outdir = pjoin('source','api','generated')
docwriter = ApiDocWriter(package,rst_extension='.txt')
Brian Granger
Cleanup of docs....
r2275 # You have to escape the . here because . is a special char for regexps.
# You must do make clean if you change this!
Fernando Perez
Update docs for automatic API building.
r1850 docwriter.package_skip_patterns += [r'\.fixes$',
Brian Granger
Cleanup of docs....
r2275 r'\.external$',
Brian Granger
Renaming Extensions=>extensions in code and imports.
r2064 r'\.extensions',
Brian Granger
Cleanup of docs....
r2275 r'\.kernel\.config',
Fernando Perez
Update docs for automatic API building.
r1850 r'\.attic',
Brian Granger
General work on inputhook and the docs....
r2197 r'\.quarantine',
Brian Granger
Cleanup of docs....
r2275 r'\.deathrow',
r'\.config\.default',
r'\.config\.profile',
r'\.frontend',
r'\.gui'
Fernando Perez
Update docs for automatic API building.
r1850 ]
Brian Granger
Cleanup of docs....
r2275 docwriter.module_skip_patterns += [ r'\.core\.fakemodule',
Fernando Perez
Update docs for automatic API building.
r1850 r'\.cocoa',
r'\.ipdoctest',
r'\.Gnuplot',
Brian Granger
Cleanup of docs....
r2275 r'\.frontend\.process\.winprocess',
Fernando Perez
Several small fixes during code review with Brian....
r2339 r'\.Shell',
Fernando Perez
Update docs for automatic API building.
r1850 ]
docwriter.write_api_docs(outdir)
docwriter.write_index(outdir, 'gen',
relative_to = pjoin('source','api')
)
print '%d files written' % len(docwriter.written_modules)