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
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
|
#!/bin/env python3
# This script converts API YAML files into markdown documentation
# and prints it to standard out.
from datetime import datetime
import re
import yaml
def escape(text, spaces=False):
"""
Escapes text for safe inclusion in groff documents.
- Escapes backslashes as '\\e'
- Escapes periods at the start of a line as '\\&.'
"""
escaped_lines = []
for line in text.splitlines():
# Escape backslashes
line = line.replace("\\", r"\[rs]")
# Escape leading period or apostrophe (groff macro triggers)
if line.startswith('.'):
line = r'\&' + line
elif line.startswith("'"):
line = r'\&' + line
if spaces:
line = line.replace(' ', '\\ ')
escaped_lines.append(line)
return '\n'.join(escaped_lines)
def arg_signature(name, arg):
sig = name
if "type" in arg:
sig = sig + ": " + arg["type"]
if "default" in arg:
sig = sig + " = " + arg["default"]
return sig
def get_signature(name, info):
if "type" in info:
return ".BI " +escape(f'{name} : {info["type"]}', spaces=True)
sig = f'{name} : func('
if info["args"]:
sig += ", ".join(arg_signature(name,arg) for name,arg in info["args"].items())
sig += " -> " + info["return"].get("type", "Void")
else:
sig += "-> " + info["return"].get("type", "Void")
sig += ')'
return ".BI " + escape(sig, spaces=True)
template = ''''\\" t
.\\" Copyright (c) {year} Bruce Hill
.\\" All rights reserved.
.\\"
.TH {name} 3 {date} "Tomo man-pages"
.SH NAME
{name} \\- {short}
.SH LIBRARY
Tomo Standard Library
.SH SYNOPSIS
.nf
{signature}
.fi
.SH DESCRIPTION
{description}
'''
arg_prefix = '''
.TS
allbox;
lb lb lbx lb
l l l l.
Name Type Description Default'''
type_template = ''''\\" t
.\\" Copyright (c) {year} Bruce Hill
.\\" All rights reserved.
.\\"
.TH {type} 3 {date} "Tomo man-pages"
.SH NAME
{type} \\- a Tomo type
.SH LIBRARY
Tomo Standard Library
.fi
.SH METHODS
{methods}
'''
def markdown_to_roff(text):
text = text.replace('\n', ' ')
text = re.sub(r'`([^`]*)`', '\\\\fB\\1\\\\fR', text)
return text
def write_method(path, name, info):
lines = []
year = datetime.now().strftime("%Y")
date = datetime.now().strftime("%Y-%m-%d")
signature = get_signature(name, info)
lines.append(template.format(year=year, date=date, name=name, short=info["short"], description=info["description"], signature=signature))
if "args" in info and info["args"]:
lines.append(".SH ARGUMENTS")
lines.append(arg_prefix)
for arg,arg_info in info["args"].items():
default = escape(arg_info['default'], spaces=True) if 'default' in arg_info else '-'
description = markdown_to_roff(arg_info['description'])
lines.append(f"{arg}\t{arg_info.get('type', '')}\t{description}\t{default}")
lines.append(".TE")
if "return" in info:
lines.append(".SH RETURN")
lines.append(info['return'].get('description', 'Nothing.'))
if "note" in info:
lines.append(".SH NOTES")
lines.append(info["note"])
if "errors" in info:
lines.append(".SH ERRORS")
lines.append(info["errors"])
if "example" in info:
lines.append(".SH EXAMPLES")
lines.append(".EX")
lines.append(escape(info['example']))
lines.append(".EE")
if "." in name:
type,_ = name.split(".")
lines.append(".SH SEE ALSO")
lines.append(f".BR Tomo-{type} (3)")
to_write = '\n'.join(lines) + '\n'
try:
with open(path, "r") as f:
existing = f.read()
if to_write.splitlines()[5:] == existing.splitlines()[5:]:
return
except FileNotFoundError:
pass
with open(path, "w") as f:
f.write(to_write)
print(f"Updated {path}")
fn_summary_template = '''
.TP
{signature}
{description}
For more, see:
.BR Tomo-{type}.{name} (3)
'''
def fn_summary(type, name, info) -> str:
signature = get_signature(type+"."+name, info)
return fn_summary_template.format(
type=type,
name=name,
signature=signature,
description=markdown_to_roff(info["description"]),
)
def write_type_manpage(path, type, methods):
year = datetime.now().strftime("%Y")
date = datetime.now().strftime("%Y-%m-%d")
method_summaries = [fn_summary(type, name, methods[name]) for name in sorted(methods.keys())]
type_manpage = type_template.format(
year=year,
date=date,
type=type,
methods='\n'.join(method_summaries),
)
try:
with open(path, "r") as f:
existing = f.read()
if type_manpage.splitlines()[5:] == existing.splitlines()[5:]:
return
except FileNotFoundError:
pass
with open(path, "w") as f:
f.write(type_manpage)
print(f"Updated {path}")
def convert_to_markdown(yaml_doc:str)->str:
data = yaml.safe_load(yaml_doc)
types = {}
for name,info in data.items():
write_method(f"man/man3/tomo-{name}.3", name, data[name])
if "." in name:
type,fn = name.split(".")
if type not in types:
types[type] = {}
types[type][fn] = info
for type,methods in types.items():
write_type_manpage(f"man/man3/tomo-{type}.3", type, methods)
if __name__ == "__main__":
import sys
if len(sys.argv) > 1:
all_files = ""
for filename in sys.argv[1:]:
with open(filename, "r") as f:
all_files += f.read()
convert_to_markdown(all_files)
else:
convert_to_markdown(sys.stdin.read())
|
