1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
#!/usr/bin/env python
# emacs: -*- mode: python; py-indent-offset: 4; indent-tabs-mode: nil -*-
# vi: set ft=python sts=4 ts=4 sw=4 et:
"""Script to auto-generate our API docs.
"""
# stdlib imports
import os
import sys
#*****************************************************************************
if __name__ == '__main__':
nipypepath = os.path.abspath('..')
sys.path.insert(1, nipypepath)
package = 'nipype'
# local imports
from apigen import ApiDocWriter
outdir = os.path.join('api', 'generated')
docwriter = ApiDocWriter(package)
# Packages that should not be included in generated API docs.
docwriter.package_skip_patterns += ['\.external$',
'\.utils$',
'\.interfaces\.',
'\.workflows$',
'\.pipeline\.plugins$',
'\.testing$',
'\.fixes$',
'\.algorithms$',
]
# Modules that should not be included in generated API docs.
docwriter.module_skip_patterns += ['\.version$',
'info',
'\.interfaces\.(?!(base|matlab))',
'\.pipeline\.utils$',
'\.interfaces\.slicer\.generate_classes$',
'\.interfaces\.pymvpa$',
]
docwriter.write_api_docs(outdir)
docwriter.write_index(outdir, 'gen', relative_to='api')
print '%d files written' % len(docwriter.written_modules)
|
