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
|
#!/usr/bin/env python3
# Copyright 2022 The Bazel Authors. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""merge stardoc output into a single page.
- concatenates files
- corrects things that stardoc botches
"""
import re
import sys
import typing
ID_RE = re.compile(r'<a id="#(.*)">')
WRAPS_RE = re.compile(r'@wraps\((.*)\)')
SINCE_RE = re.compile(r'@since\(([^)]*)\)')
CENTER_RE = re.compile(r'<p align="center">([^<]*)</p>')
def merge_file(file: str, out, wrapper_map:typing.Dict[str, str]) -> None:
with open(file, 'r') as inp:
content = inp.read()
m = ID_RE.search(content)
this_pkg = m.group(1) if m else None
m = WRAPS_RE.search(content)
if m:
# I wrap something, so don't emit me.
wrapper_map[m.group(1)] = this_pkg
return
# If something wraps me, rewrite myself with the wrapper name.
if this_pkg in wrapper_map:
content = content.replace(this_pkg, wrapper_map[this_pkg])
merge_text(content, out)
def merge_text(text: str, out) -> None:
"""Merge a block of text into an output stream.
Args:
text: block of text produced by Starroc.
out: an output file stream.
"""
for line in text.split('\n'):
line = SINCE_RE.sub(r'<div class="since"><i>Since \1</i></div>', line)
if line.startswith('| :'):
line = fix_stardoc_table_align(line)
# Compensate for https://github.com/bazelbuild/stardoc/issues/118.
# Convert escaped HTML <li> back to raw text
line = line.replace('<li>', '<li>')
line = CENTER_RE.sub(r'\1', line)
_ = out.write(line)
_ = out.write('\n')
def fix_stardoc_table_align(line: str) -> str:
"""Change centered descriptions to left justified."""
if line.startswith('| :-------------: | :-------------: '):
return '| :------------ | :--------------- | :---------: | :---------: | :----------- |'
return line
def main(argv: typing.Sequence[str]) -> None:
wrapper_map = {}
for file in argv[1:]:
merge_file(file, sys.stdout, wrapper_map)
if __name__ == '__main__':
main(sys.argv)
|
