forked from ooni/pipeline
-
Notifications
You must be signed in to change notification settings - Fork 0
/
build_docs.py
executable file
·398 lines (314 loc) · 11 KB
/
build_docs.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
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
#!/usr/bin/env python3
"""
Generate docs from module docstrigs
Link #<int> to github issue
Link <repo>#<int> to github issue
List #TODO and #FIXME
debdeps: asciidoc-base (>= 8.6.9)
debdeps: python3-markdown
"""
from configparser import ConfigParser
from io import StringIO
from pathlib import Path
from subprocess import check_call
from tempfile import NamedTemporaryFile
from textwrap import dedent
from typing import List
import ast
import base64
import sys
import zlib
try:
# debdeps: asciidoc-base (>= 9.0.0)
sys.path.append("/usr/share/asciidoc")
import asciidocapi
asciidoc_available = True
except ImportError:
asciidoc_available = False
try:
# debdeps: python3-markdown
import markdown
from markdown.extensions.toc import TocExtension
from markdown.extensions.codehilite import CodeHiliteExtension
from markdown.extensions.fenced_code import FencedCodeExtension
markdown_available = True
except ImportError:
markdown_available = False
# debdeps: python3-blockdiag
HTMLTPL = dedent(
"""
<!doctype html>
<html>
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>{title}</title>
{head_links}
<style>
{css}
</style>
</head>
<body>
<div class="header">
<div class="row">
<div class="column">
<h2>Project documentation</h2>
</div>
</div>
</div>
<div class="container">
"""
)
conf = None
def load_conf():
confp = ConfigParser()
with open("build_docs.ini") as f:
confp.read_file(f)
return confp["DEFAULT"]
def glob_ext(ignored, ext):
for f in sorted(Path(".").glob(f"**/*.{ext}")):
if any(i in f.as_posix() for i in ignored):
continue
yield f
def _scan_ast(i, skipfirst=True):
for y in ast.iter_child_nodes(i):
if isinstance(y, ast.Expr) and isinstance(y.value, ast.Str):
if skipfirst:
skipfirst = False
else:
yield y.value.s, y.lineno
def extract_python_doc(inputf) -> List:
"""Extract documentation strings from a Python file"""
a = ast.parse(inputf.read_text())
out = []
def unroll(g):
for item in g:
s = str(item).strip()
if s:
out.append(s)
out.extend(_scan_ast(a, skipfirst=False))
for i in ast.iter_child_nodes(a):
if isinstance(i, ast.FunctionDef):
out.extend(_scan_ast(i))
elif isinstance(i, ast.ClassDef):
out.extend(_scan_ast(i))
for x in ast.iter_child_nodes(i):
if isinstance(x, ast.FunctionDef):
out.extend(_scan_ast(x))
return out
def render_adoc(orig_source_f: Path, infile: StringIO):
outfile = conf.outdir / orig_source_f.with_suffix(".html")
outfile.parent.mkdir(parents=True, exist_ok=True)
ad = asciidocapi.AsciiDocAPI()
ad.attributes["author"] = conf.get("author", "")
infile.seek(0)
with outfile.open("w") as outf:
ad.execute(infile, outf, backend="html5")
def render_markdown(orig_source_f: Path, inp: str):
outfile = conf.outdir / orig_source_f.with_suffix(".html")
outfile.parent.mkdir(parents=True, exist_ok=True)
print(outfile)
content = markdown.markdown(
inp,
extensions=[
TocExtension(baselevel=3, permalink=' #'),
CodeHiliteExtension(),
FencedCodeExtension(),
],
)
html = wrap_page(orig_source_f, content)
outfile.write_text(html)
def generate_github_link(action: str, f: Path):
# action: blob edit
url_tpl = conf.get("github_url_template")
return url_tpl.format(action=action, path=f.as_posix(), lineno=0)
def generate_github_link_unused(action, f, lineno):
# action: blob edit
url_tpl = conf.get("github_url_template")
url = url_tpl.format(action=action, path=f.as_posix(), lineno=lineno)
adoc_tpl = f"""image:{action}.svg[link="{url}"]"""
# return f"""\nimage::https://asciidoctor.org/images/octocat.jpg[link="{url}"]\n"""
return adoc_tpl
def generate_badge(url, text):
tpl = """<a href="{url}" class="button button-outline button-small">{text}</a>"""
return tpl.format(url=url, text=text)
def generate_header_path(inputf: Path) -> str:
s = []
backticker = "/".join([".."] * len(inputf.parents))
if backticker:
backticker += "/"
pc = len(inputf.parents)
for depth, x in enumerate(reversed(inputf.parents)):
item = "link:{}{}[{}]".format(backticker, str(x), x.name)
backticker = "/".join([".."] * (pc - depth - 1))
item = "link:{}[{}]".format(backticker, x.name)
s.append(item)
last = "link:[{}]\n".format(inputf.name)
s.append(last)
out = " -> ".join(s)
return out
def generate_header_path_html(inputf: Path) -> str:
s = []
backticker = "/".join([".."] * len(inputf.parents))
if backticker:
backticker += "/"
pc = len(inputf.parents)
for depth, x in enumerate(reversed(inputf.parents)):
backticker = "/".join([".."] * (pc - depth - 1))
item = "<a href='{}/index.html'>{}</a>".format(backticker, x.name)
s.append(item)
# last = "[{}](.)".format(inputf.name)
last = "<a href=''>{}</a>".format(inputf.name)
s.append(last)
out = " » ".join(s)
return """<div id="pagepath">""" + out + "</div>"
def generate_view_badge(f: Path):
url = generate_github_link("blob", f)
return generate_badge(url, "view")
def generate_edit_badge(f: Path):
url = generate_github_link("edit", f)
return generate_badge(url, "edit")
def generate_python_adoc(inputf: Path, pdoc: List):
adoc = []
adoc.append(generate_header_path(inputf))
for content, lineno in pdoc:
# gh_b = generate_github_link("blob", inputf, lineno)
# f.write(gh_b)
adoc.append("++++")
adoc.append(generate_view_badge(inputf))
adoc.append(generate_edit_badge(inputf))
adoc.append("++++")
adoc.append("\n" + content + "\n")
return StringIO("\n".join(adoc))
def generate_html_begin(orig_source_f):
hl = conf.get("html_imports", "")
css = conf.get("css", "")
return HTMLTPL.format(title=orig_source_f.name, head_links=hl, css=css)
def wrap_page(orig_source_f, content):
begin = generate_html_begin(orig_source_f)
header = generate_header_path_html(orig_source_f)
footer = conf.get("footer", "")
end = "</div>" + footer + "</body></html>"
return begin + header + content + end
def generate_python_markdown(inputf: Path, pdoc: List):
lines = []
for content, lineno in pdoc:
lines.append(generate_view_badge(inputf))
lines.append(generate_edit_badge(inputf))
lines.append("\n" + content + "\n")
return "\n".join(lines)
def render_blockdiag(diag: str) -> str:
"""Render blockdiag to SVG"""
print("Rendering blockdiag")
inp = NamedTemporaryFile("w")
inp.write(diag)
inp.flush()
out = NamedTemporaryFile("r")
cmd = ["/usr/bin/blockdiag3", "-T", "svg", "-o", out.name, inp.name]
check_call(cmd)
svg = out.read()
_, _, svg = svg.split("\n", 2)
return svg
def process_diagrams(md: str) -> str:
"""Extract diagrams and replace them with SVG/PNG images"""
out = ""
for block in md.split("\nblockdiag {"):
try:
diag, post = block.split("\n}", 1)
diag = "blockdiag {\n" + diag + "\n}\n"
# url = generate_kroki_url(diag, "blockdiag")
# exp = "https://kroki.io/blockdiag/svg/eNpdzDEKQjEQhOHeU4zpPYFoYesRxGJ9bwghMSsbUYJ4d10UCZbDfPynolOek0Q8FsDeNCestoisNLmy-Qg7R3Blcm5hPcr0ITdaB6X15fv-_YdJixo2CNHI2lmK3sPRA__RwV5SzV80ZAegJjXSyfMFptc71w=="
# assert url == exp, url
# url = f"""<img src="{url}">"""
# out += url
svg = render_blockdiag(diag)
out += f"\n<div>{svg}</div>"
out += post
except ValueError as e:
out += block
return out
# assert process_diagrams("") == ""
# svg = process_diagrams("a\nblockdiag {\n}\nb")
# assert svg == """a
# <svg viewBox="0 0 256 120" xmlns="http://www.w3.org/2000/svg" xmlns:inkspace="http://www.inkscape.org/namespaces/inkscape" xmlns:xlink="http://www.w3.org/1999/xlink">
# <defs id="defs_block">
# <filter height="1.504" id="filter_blur" inkspace:collect="always" width="1.1575" x="-0.07875" y="-0.252">
# <feGaussianBlur id="feGaussianBlur3780" inkspace:collect="always" stdDeviation="4.2" />
# </filter>
# </defs>
# <title>blockdiag</title>
# <desc>blockdiag {
#
# }
# </desc>
# </svg>
#
# b""", svg
def generate_kroki_url(content, method: str) -> str:
"""Generate URL for https://kroki.io/"""
# FIXME: Broken
if method != "blockdiag":
raise NotImplementedError
baseurl = "https://kroki.io/graphviz/svg/"
content = content.encode()
path = base64.urlsafe_b64encode(zlib.compress(content, 9))
path = path.decode()
return baseurl + path
def create_index_html(basedir: Path):
"""Recursively create index.html files"""
for d in basedir.iterdir():
if d.is_dir():
create_index_html(d)
out = generate_html_begin(basedir)
out += generate_header_path_html(basedir)
out += "<ul>"
for f in sorted(basedir.iterdir()):
n = f.with_suffix("").name
if f.is_dir():
out += "<li><a href='{}/index.html'>» {}</a></li>".format(f.name, n)
elif f.suffix == ".html":
out += "<li><a href='{}'>{}</a></li>".format(f.name, n)
footer = conf.get("footer", "")
footer = "</ul></div>" + footer + "</body></html>"
out += footer
indexf = basedir / "index.html"
indexf.write_text(out)
def main():
global conf
conf = load_conf()
ignored = conf.get("ignore_paths_substr", "").split()
markup_format = conf.get("markup_format", "markdown")
conf.outdir = Path(conf.get("outdir", "build_docs_output"))
conf.outdir.mkdir(parents=True, exist_ok=True)
if markup_format == "asciidoc":
print("Rendering AsciiDoc files")
for adocf in glob_ext(ignored, "adoc"):
# render_adoc(renderer, adocf)
pass
elif markup_format == "markdown":
print("Rendering MarkDown files")
for f in glob_ext(ignored, "md"):
md = f.read_text()
md = process_diagrams(md)
render_markdown(f, md)
pass
print("Rendering Python files")
for pyfile in glob_ext(ignored, "py"):
try:
pdoc = extract_python_doc(pyfile)
if not len(pdoc):
continue
if markup_format == "asciidoc":
raise NotImplementedError
adocf = generate_python_adoc(pyfile, pdoc)
render_adoc(pyfile, adocf)
elif markup_format == "markdown":
md = generate_python_markdown(pyfile, pdoc)
md = process_diagrams(md)
render_markdown(pyfile, md)
except Exception as e:
print(e)
create_index_html(conf.outdir)
print("Done")
if __name__ == "__main__":
main()