forked from taichi-dev/taichi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
generate_ir_design_doc.py
74 lines (63 loc) · 2.24 KB
/
generate_ir_design_doc.py
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
import os
import yaml
from taichi.core import settings
def extract_doc(doc_filename=None):
statements_fn = os.path.join(os.path.dirname(__file__), "../taichi/ir/statements.h")
with open(statements_fn, "r") as f:
statements = f.readlines()
class_doc = {}
for i in range(len(statements)):
line = statements[i]
start_pos = line.find("/**")
if start_pos == -1:
continue
current_doc = line[start_pos + 3 :].strip()
doc_ends_at_line = 0
for j in range(i + 1, len(statements)):
next_line = statements[j]
end_pos = next_line.find("*/")
if end_pos != -1:
doc_ends_at_line = j
break
next_line = next_line.strip()
if next_line.startswith("*"):
next_line = next_line[1:].strip()
if next_line == "": # an empty line
current_doc += "\n"
else:
current_doc += " " + next_line
current_doc = current_doc.strip()
line = statements[doc_ends_at_line + 1]
start_pos = line.find("class")
if start_pos == -1:
print(
"We only support doc for classes now. "
f"The following doc at line {i}-{doc_ends_at_line} "
"cannot be recognized:\n"
f"{current_doc}"
)
continue
class_name = line[start_pos + 5 :].strip().split()[0]
class_doc[class_name] = current_doc
if doc_filename is None:
doc_filename = "ir_design_doc.yml"
with open(doc_filename, "w") as f:
yaml.dump(class_doc, f, Dumper=yaml.SafeDumper)
def yml_to_md(yml_filename=None, md_filename=None):
if yml_filename is None:
yml_filename = "ir_design_doc.yml"
if md_filename is None:
md_filename = "ir_design_doc.md"
with open(yml_filename, "r") as f:
doc_yml = yaml.load(f, Loader=yaml.SafeLoader)
doc_md = ""
for class_name, class_doc in doc_yml.items():
doc_md += f"### {class_name}\n"
doc_md += class_doc
doc_md += "\n\n"
with open(md_filename, "w") as f:
f.write(doc_md)
if __name__ == "__main__":
extract_doc()
yml_to_md()
print("Done!")