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
|
#!/usr/bin/env python
"""Script to auto-generate our API docs."""
import sys
from packaging import version as _version
# local imports
from apigen import ApiDocWriter
# *****************************************************************************
def abort(error):
print(f'*WARNING* API documentation not generated: {error}')
exit()
if __name__ == '__main__':
package = 'skimage'
# Check that the 'image' 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:
abort("Can not import skimage")
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.
# exclude any appended git hash and date
installed_version = _version.parse(module.__version__.split('+git')[0])
source_lines = open('../src/skimage/__init__.py').readlines()
version = 'vUndefined'
for l in source_lines:
if l.startswith('__version__ = '):
source_version = _version.parse(l.split("'")[1])
break
if source_version != installed_version:
abort("Installed version does not match source version")
outdir = 'source/api'
docwriter = ApiDocWriter(package)
docwriter.package_skip_patterns += [
r'\.fixes$',
r'\.externals$',
r'filter$',
]
docwriter.write_api_docs(outdir)
docwriter.write_index(outdir, 'api', relative_to='source/api')
if len(docwriter.written_modules) <= 1:
msg = (
f"expected more modules, only wrote files for: "
f"{docwriter.written_modules!r}"
)
raise RuntimeWarning(msg)
else:
print(f'{len(docwriter.written_modules)} files written')
|
