embedded-system/gen_summary.py at gitbook · xym-ee/embedded-system · GitHub

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
#!/usr/bin/env python3

'''
根 README = 封面（只输出，不当父节点）

ROOT 下所有目录 README 与根 README 同级

从第二层开始递归缩进

每个目录 README = 模块节点

普通 md = 模块内容

普通 md 永远挂在同目录 README 下

'''


#!/usr/bin/env python3
import os
import re

ROOT = "."
OUTPUT = "SUMMARY.md"

IGNORE_DIRS = {".git", "_book", "node_modules", ".venv"}
TITLE_RE = re.compile(r"^\s*#\s+(.*)")

def natural_key(s):
    """
    支持:
    01_xxx -> 1
    1-2 -> 1,2
    10bit -> 10,bit
    """
    parts = re.split(r'[\-_\.]', s)
    key = []

    for part in parts:
        subs = re.split(r'(\d+)', part)
        for item in subs:
            if item.isdigit():
                key.append(int(item))
            else:
                key.append(item.lower())

    return key

def title_of(path):
    try:
        with open(path, "r", encoding="utf-8") as f:
            for line in f:
                m = TITLE_RE.match(line)
                if m:
                    return m.group(1).strip()
    except:
        pass

    return os.path.splitext(os.path.basename(path))[0]

def rel(path):
    return "./" + os.path.relpath(path, ROOT).replace("\\", "/")

def generate(dir_path, level, lines):
    entries = sorted(os.listdir(dir_path), key=natural_key)

    readme = None
    subdirs = []
    files = []

    for entry in entries:
        full = os.path.join(dir_path, entry)

        if entry in IGNORE_DIRS:
            continue

        if os.path.isdir(full):
            subdirs.append(full)
        elif entry.lower() == "readme.md":
            readme = full
        elif entry.endswith(".md") and entry != OUTPUT:
            files.append(full)

    # ROOT：封面，只输出，不参与层级
    if dir_path == ROOT:
        if readme:
            lines.append(f"- [{title_of(readme)}]({rel(readme)})")

        for sub in subdirs:
            generate(sub, 0, lines)
        return

    # 模块 README
    if readme:
        indent = "  " * level
        lines.append(f"{indent}- [{title_of(readme)}]({rel(readme)})")
    else:
        print(f"⚠ Warning: {dir_path} has no README.md")

    # 子模块
    for sub in subdirs:
        generate(sub, level + 1, lines)

    # 模块内容 md
    for f in files:
        indent = "  " * (level + 1)
        lines.append(f"{indent}- [{title_of(f)}]({rel(f)})")

def main():
    lines = ["# 目录\n"]
    generate(ROOT, 0, lines)

    with open(OUTPUT, "w", encoding="utf-8") as f:
        f.write("\n".join(lines))

    print("SUMMARY.md generated.")

if __name__ == "__main__":
    main()