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
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
|
#!/usr/bin/env python
"""Script to auto-generate our API docs.
"""
# stdlib imports
import sys
import re
import os
from os.path import join as pjoin
# local imports
from apigen import ApiDocWriter
# version comparison
from distutils.version import LooseVersion as V
# *****************************************************************************
def abort(error):
print('*WARNING* API documentation not generated: %s' % error)
exit(1)
if __name__ == '__main__':
package = sys.argv[1]
outdir = sys.argv[2]
try:
other_defines = sys.argv[3]
except IndexError:
other_defines = True
else:
other_defines = other_defines in ('True', 'true', '1')
# Check that the package is available. If not, the API documentation is not
# (re)generated and existing API documentation sources will be used.
try:
__import__(package)
except ImportError as e:
abort("Can not import " + package)
module = sys.modules[package]
# Check that the source version is equal to the installed
# version. If the versions mismatch the API documentation sources
# are not (re)generated. This avoids automatic generation of documentation
# for older or newer versions if such versions are installed on the system.
installed_version = V(module.__version__)
version_file = pjoin('..', package, '_version.py')
source_version = None
if os.path.exists(version_file):
# Versioneer
from runpy import run_path
try:
source_version = run_path(version_file)['get_versions']()['version']
except (FileNotFoundError, KeyError):
pass
if source_version == '0+unknown':
source_version = None
if source_version is None:
# Legacy fall-back
info_file = pjoin('..', package, 'info.py')
info_lines = open(info_file).readlines()
source_version = '.'.join([v.split('=')[1].strip(" '\n.")
for v in info_lines if re.match(
'^_version_(major|minor|micro|extra)', v
)])
print('***', source_version)
if source_version != installed_version:
abort("Installed version does not match source version")
docwriter = ApiDocWriter(package, rst_extension='.rst',
other_defines=other_defines)
docwriter.package_skip_patterns += [r'\.fixes$',
r'\.fixes.*$',
r'\.externals$',
r'\.externals.*$',
r'.*test.*$',
r'\.info.*$',
r'\.pkg_info.*$',
r'\.py3k.*$',
]
docwriter.write_api_docs(outdir)
docwriter.write_index(outdir, 'index', relative_to=outdir)
print('%d files written' % len(docwriter.written_modules))
|
