1
0
mirror of https://gitee.com/openLuat/LuatOS synced 2025-08-17 22:18:03 +08:00

add: 文档加上支持芯片型号的列表

This commit is contained in:
chenxuuu 2022-11-28 15:15:26 +08:00
parent 239d849703
commit 53f0fd384d
No known key found for this signature in database
GPG Key ID: B1A462D4300513F3
2 changed files with 34 additions and 3 deletions

View File

@ -110,6 +110,7 @@ def get_modules(file_list, start="/*", end="*/"):
module["usage"] = ""
module["demo"] = ""
module["video"] = ""
module["tag"] = ""
module["api"] = []
module["const"] = []
else:
@ -138,6 +139,10 @@ def get_modules(file_list, start="/*", end="*/"):
module["video"] = re.search(" *@video * (.+) *",lines[line_now],re.I).group(1)
line_now+=1
continue
if re.search(" *@tag *.+",lines[line_now],re.I):
module["tag"] = re.search(" *@tag * (.+) *",lines[line_now],re.I).group(1)
line_now+=1
continue
if re.search(" *@usage *",lines[line_now],re.I):
line_now+=1
while lines[line_now].find(end) < 0:

View File

@ -1,5 +1,26 @@
import shutil
import os
import requests
#bsp.h文件列表
bsp_header_list = [
{"name":"Air101/Air103","url":"https://gitee.com/openLuat/luatos-soc-air101/raw/master/app/port/luat_conf_bsp.h"},
{"name":"Air105","url":"https://gitee.com/openLuat/luatos-soc-air105/raw/master/application/include/luat_conf_bsp.h"},
{"name":"ESP32C3","url":"https://gitee.com/openLuat/luatos-soc-idf5/raw/master/luatos/include/luat_conf_bsp.h"},
{"name":"Air780","url":"https://gitee.com/openLuat/luatos-soc-2022/raw/master/project/luatos/inc/luat_conf_bsp.h"},
]
print("getting bsp.h files...")
for bsp in bsp_header_list:
print("getting "+bsp["name"]+"...")
bsp["url"] = requests.get(bsp["url"]).text
print("done "+ str(len(bsp["url"])) + " bytes")
def get_tags(tag):
r = []
for bsp in bsp_header_list:
if bsp["url"].find(" "+tag) >= 0:
r.append("{bdg-primary}`" + bsp["name"] + "`")
return " ".join(r)
def make(path,modules,index_text):
try:
@ -14,13 +35,18 @@ def make(path,modules,index_text):
for module in modules:
mdoc = open(path+module["module"]+".md", "a+",encoding='utf-8')
mdoc.write("# "+module["module"]+" - "+module["summary"]+"\n\n")
if len(module["tag"]) > 0:
mdoc.write(get_tags(module["tag"]))
mdoc.write("\n\n")
if len(module["url"]) > 0:
mdoc.write("> 本页文档由[这个文件]("+module["url"]+")自动生成。如有错误请提交issue或帮忙修改后pr谢谢\n\n")
mdoc.write("```{note}\n本页文档由[这个文件]("+module["url"]+")自动生成。如有错误请提交issue或帮忙修改后pr谢谢\n```\n\n")
if len(module["demo"]) > 0:
mdoc.write("> 本库有专属demo[点此链接查看"+module["module"]+"的demo例子]("+module["demo"]+")\n")
mdoc.write("```{tip}\n本库有专属demo[点此链接查看"+module["module"]+"的demo例子]("+module["demo"]+")\n```\n")
if len(module["video"]) > 0:
mdoc.write("> 本库还有视频教程,[点此链接查看]("+module["video"]+")\n\n")
mdoc.write("```{tip}\n本库还有视频教程,[点此链接查看]("+module["video"]+")\n```\n\n")
else:
mdoc.write("\n")