76 lines
1.6 KiB
Python
76 lines
1.6 KiB
Python
import glob
|
|
import os
|
|
import ntpath
|
|
|
|
#-------------------------------------------------------------------------------
|
|
|
|
def extract_rst_blobs(s_in):
|
|
s_out = []
|
|
is_rst_line = False
|
|
for line in s_in.split('\n'):
|
|
if is_rst_line:
|
|
if len(line) > 0:
|
|
if line[0] != '#':
|
|
is_rst_line = False
|
|
else:
|
|
is_rst_line = False
|
|
if is_rst_line:
|
|
s_out.append(line[2:])
|
|
if '#.rst:' in line:
|
|
is_rst_line = True
|
|
return '\n'.join(s_out)
|
|
|
|
def test_extract_rst_blobs():
|
|
s_in = '''# a
|
|
# b
|
|
#.rst:
|
|
# c
|
|
# d
|
|
|
|
# e
|
|
# f
|
|
g
|
|
h
|
|
# i
|
|
# j
|
|
#.rst:
|
|
# k
|
|
# l'''
|
|
s_out = '''c
|
|
d
|
|
k
|
|
l'''
|
|
|
|
assert s_out == extract_rst_blobs(s_in)
|
|
|
|
#-------------------------------------------------------------------------------
|
|
|
|
def main():
|
|
|
|
THIS_DIR = os.path.dirname(os.path.realpath(__file__))
|
|
|
|
output = []
|
|
output.append("Module reference")
|
|
output.append("================")
|
|
output.append("\n")
|
|
|
|
files = glob.glob('%s/*.cmake' % os.path.join(THIS_DIR, '..', 'modules'))
|
|
|
|
for f in sorted(files):
|
|
file_name = ntpath.basename(f)
|
|
output.append('\n\n%s' % file_name)
|
|
output.append('-'*len(file_name))
|
|
with open(f, 'r') as s:
|
|
s_out = extract_rst_blobs(s.read())
|
|
if s_out == '':
|
|
output.append('\nNo documentation\n')
|
|
else:
|
|
output.append(s_out)
|
|
|
|
with open(os.path.join(THIS_DIR, 'module-reference.rst'), 'w') as f:
|
|
f.write('\n'.join(output))
|
|
|
|
#-------------------------------------------------------------------------------
|
|
|
|
main()
|