generate_plugin_docs.py
5.2 KB
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
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
import os
import re
def subfiles(path):
return [name for name in os.listdir(path) if os.path.isfile(os.path.join(path, name)) and not name[0] == '.']
def subdirs(path):
return [name for name in os.listdir(path) if os.path.isdir(os.path.join(path, name))]
def formatModule(module):
if module == 'io':
return 'i/o'
else:
return module.capitalize()
def parse(group):
docs = re.compile('/\*\!(.*?)\*/', re.DOTALL)
docsMatch = docs.match(group)
clss = group[docsMatch.end():].strip()
if len(clss) == 0 or 'class' not in clss:
return None
blocks = docsMatch.group().split('\\')[1:]
if len(blocks) == 0:
return None
attributes = {}
for block in blocks:
key = block[:block.find(' ')]
value = block[block.find(' '):].split('\n')[0].strip()
if key in attributes:
attributes[key].append(value)
else:
attributes[key] = [value]
attributes['Name'] = clss[5:clss.find(':')].strip()
attributes['Parent'] = clss[clss.find('public')+6:].strip().strip(',') # Handles the edge case of multiple inheritence
return attributes
def parseInheritance(inheritance):
abstractions = ['Transform', 'UntrainableTransform',
'MetaTransform', 'UntrainableMetaTransform',
'MetadataTransform', 'UntrainableMetadataTransform',
'TimeVaryingTransform',
'Distance', 'UntrainableDistance',
'Output', 'MatrixOutput',
'Format',
'Gallery', 'FileGallery',
'Representation',
'Classifier'
]
if inheritance in abstractions:
return '../cpp_api/' + inheritance.lower() + '/' + inheritance.lower() + '.md'
else: # Not an abstraction must inherit in the local file!
return '#' + inheritance.lower()
def parseSees(sees):
if not sees:
return ""
output = "* **see:**"
if len(sees) > 1:
output += "\n\n"
for see in sees:
output += "\t* [" + see + "](" + see + ")\n"
output += "\n"
else:
link = sees[0]
if not 'http' in link:
link = '#' + link.lower()
output += " [" + sees[0] + "](" + link + ")\n"
return output
def parseAuthors(authors):
if not authors:
return "* **authors:** None\n"
output = "* **author"
if len(authors) > 1:
output += "s:** " + ", ".join(authors) + "\n"
else:
output += ":** " + authors[0] + "\n"
return output
def parseProperties(properties):
if not properties:
return "* **properties:** None\n\n"
output = "* **properties:**\n\n"
output += "Property | Type | Description\n"
output += "--- | --- | ---\n"
for prop in properties:
split = prop.split(' ')
ty = split[0]
name = split[1]
desc = ' '.join(split[2:])
table_regex = re.compile('\[(.*?)\]')
table_match = table_regex.search(desc)
while table_match:
before = desc[:table_match.start()]
after = desc[table_match.end():]
table_content = desc[table_match.start()+1:table_match.end()-1].split(',')
table = "<ul>"
for field in table_content:
table += "<li>" + field.strip() + "</li>"
table += "</ul>"
desc = before.strip() + table + after.strip()
table_match = table_regex.search(desc)
output += name + " | " + ty + " | " + desc + "\n"
return output
def main():
plugins_dir = '../../openbr/plugins/'
output_dir = '../docs/docs/plugins/'
for module in subdirs(plugins_dir):
if module == "cmake":
continue
output_file = open(os.path.join(output_dir, module + '.md'), 'w+')
names = []
docs = {} # Store the strings here first so they can be alphabetized
for plugin in subfiles(os.path.join(plugins_dir, module)):
f = open(os.path.join(os.path.join(plugins_dir, module), plugin), 'r')
content = f.read()
regex = re.compile('/\*\!(.*?)\*/\n(.*?)\n', re.DOTALL)
it = regex.finditer(content)
for match in it:
attributes = parse(match.group())
if not attributes or (attributes and attributes["Parent"] == "Initializer"):
continue
plugin_string = "# " + attributes["Name"] + "\n\n"
plugin_string += ' '.join([brief for brief in attributes["brief"]]) + "\n\n"
plugin_string += "* **file:** " + os.path.join(module, plugin) + "\n"
plugin_string += "* **inherits:** [" + attributes["Parent"] + "](" + parseInheritance(attributes["Parent"]) + ")\n"
plugin_string += parseSees(attributes.get("see", None))
plugin_string += parseAuthors(attributes.get("author", None))
plugin_string += parseProperties(attributes.get("property", None))
plugin_string += "\n---\n\n"
names.append(attributes["Name"])
docs[attributes["Name"]] = plugin_string
for name in sorted(names):
output_file.write(docs[name])
main()