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
|
#!/usr/bin/python2
# Update API indices in documentation.
import re, os, sys, glob
subdirs = (
'libgwyddion',
'libgwyprocess',
'libgwydraw',
'libgwydgets',
'libgwymodule',
'libgwyapp',
)
bmark = r' <!-- API INDICES BEGIN -->\n'
emark = r' <!-- API INDICES END -->\n'
template = '''\
<index id="api-index-%s"%s>
<title>Index of %s</title>
<xi:include href="xml/api-index-%s.xml"><xi:fallback /></xi:include>
</index>
'''
def keyfunc(name):
if name == 'full':
return -2.0
if name == 'deprecated':
return -1.0
if not re.match('^\d+\.\d+', name):
return 0.0
name = name.split('.')
return float(name[0]) + 0.001*float(name[1])
def has_entries(filename):
return file(filename).read().find('<indexentry>') != -1
for subdir in subdirs:
docsfile = os.path.join('devel-docs', subdir, subdir + '-docs.sgml')
if not os.access(docsfile, os.R_OK):
continue
indices = glob.glob(os.path.join('devel-docs', subdir, 'xml', 'api-index-*.xml'))
indices = [x for x in indices if has_entries(x)]
indices = [re.sub('^.*?/api-index-([^/]+)\.xml$', r'\1', x) for x in indices]
out = []
for ind in sorted(indices, key=keyfunc):
if ind == 'full':
# gtk-doc now defines '-full' ID itself
xmlid = 'all'
name = 'all symbols'
role = ''
elif ind == 'deprecated':
# gtk-doc now defines '-deprecated' ID itself
xmlid = 'deprec'
name = 'deprecated symbols'
role = ' role="%s"' % ind
else:
xmlid = re.sub(r'[^0-9a-z]+', '-', ind)
name = 'new symbols in %s' % ind
role = ' role="%s"' % ind
# XXX: In Fedora's gtk-doc 1.25-2 the index is not generated when
# there is any role set. So do not use roles.
role = ''
out.append(template % (xmlid, role, name, ind))
text = file(docsfile).read()
text = re.sub(r'(?s)' + bmark + r'.*?' + emark,
bmark + ''.join(out) + emark,
text)
file(docsfile, 'w').write(text)
# vim: sw=4 ts=4 et:
|