From e3047e58d8f99ca96dc80f276c842ea081487b97 Mon Sep 17 00:00:00 2001 From: dongfeng2134 <31565799+dongfeng2134@users.noreply.github.com> Date: Thu, 12 Sep 2024 08:47:14 +0800 Subject: [PATCH 1/2] bugfix: docs\user_guidelines gen error --- docs/user_guidelines/build.sh | 14 +++++++------- docs/user_guidelines/generate_doc.py | 10 ++++++---- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/user_guidelines/build.sh b/docs/user_guidelines/build.sh index a165b830..b224e60d 100755 --- a/docs/user_guidelines/build.sh +++ b/docs/user_guidelines/build.sh @@ -2,15 +2,15 @@ set -e -# 检查 python 命令是否存在 -if command -v python >/dev/null 2>&1; then - PYTHON=python +# 检查 python3 命令是否存在 +if command -v python3 >/dev/null 2>&1; then + PYTHON=python3 else - # 如果 python 命令不存在，检查 python3 命令是否存在 - if command -v python3 >/dev/null 2>&1; then - PYTHON=python3 + # 如果 python3 命令不存在，检查 python 命令是否存在 + if command -v python >/dev/null 2>&1; then + PYTHON=python else - # 如果 python 和 python3 命令都不存在，显示错误信息并退出脚本 + # 如果 python3 和 python 命令都不存在，显示错误信息并退出脚本 echo "Error: Python 3.x not found. Please install Python 3.x or modify script to use appropriate command." >&2 exit 1 fi diff --git a/docs/user_guidelines/generate_doc.py b/docs/user_guidelines/generate_doc.py index e6e7e325..dd0980a4 100644 --- a/docs/user_guidelines/generate_doc.py +++ b/docs/user_guidelines/generate_doc.py @@ -180,7 +180,8 @@ def _preprocess(self, edition: str, pathdir: Path, suffix: str = ".md") -> None: pathfiles = [str(path) for path in pathdir.glob(f"**/*{suffix}")] # 使用 fileinput.input() 函数读取多个文件 - with fileinput.input(files=pathfiles, inplace=True, backup=".bak", encoding="utf-8") as f: + # with fileinput.input(files=pathfiles, inplace=True, backup=".bak", encoding="utf-8") as f: + with fileinput.input(files=pathfiles, inplace=True, backup=".bak") as f: keep = True # 遍历行, 处理起始为 终止为 标记的行 @@ -235,7 +236,8 @@ def _run_doxygen(self) -> None: target_string = target_string.replace("\\", "/") # 使用 fileinput 模块操作文件 - for line in fileinput.input(str(pathfile_doxyfile), inplace=True, encoding="utf-8"): + # for line in fileinput.input(str(pathfile_doxyfile), inplace=True, encoding="utf-8"): + for line in fileinput.input(str(pathfile_doxyfile), inplace=True): # Replace the target string line = re.sub(original_string, target_string, line, flags=re.MULTILINE) # Write the file out again @@ -304,8 +306,8 @@ def process(self): # 拷贝项目整体文件夹至生成目录 self._copy_project_for_preprocess(self.source, self.tadsim_docs_dir_dist) - # 预处理, 通过标记筛选文件内容 - self._preprocess(edition=self.edition, pathdir=self.tadsim_docs_dir_sphinx) + # # 预处理, 通过标记筛选文件内容 + # self._preprocess(edition=self.edition, pathdir=self.tadsim_docs_dir_sphinx) # 运行 Doxygen self._run_doxygen() From 84b8391ef4bbdbeedcabe8ff131545fd536fa427 Mon Sep 17 00:00:00 2001 From: dongfeng2134 <31565799+dongfeng2134@users.noreply.github.com> Date: Thu, 12 Sep 2024 09:53:15 +0800 Subject: [PATCH 2/2] docs: Updating the link to the simulation message description document --- ...\212\250\345\212\233\345\255\246\344\273\277\347\234\237.md" | 2 +- ...\274\240\346\204\237\345\231\250\344\273\277\347\234\237.md" | 2 +- ...\234\237\346\266\210\346\201\257\350\257\264\346\230\216.md" | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git "a/docs/user_guidelines/user_guidelines_desktop/source/305.\345\212\250\345\212\233\345\255\246\344\273\277\347\234\237.md" "b/docs/user_guidelines/user_guidelines_desktop/source/305.\345\212\250\345\212\233\345\255\246\344\273\277\347\234\237.md" index a6e7994a..8ffc0f01 100644 --- "a/docs/user_guidelines/user_guidelines_desktop/source/305.\345\212\250\345\212\233\345\255\246\344\273\277\347\234\237.md" +++ "b/docs/user_guidelines/user_guidelines_desktop/source/305.\345\212\250\345\212\233\345\255\246\344\273\277\347\234\237.md" @@ -79,7 +79,7 @@ TAD Sim 提供了 `tx_simvehicle` (乘用车动力学模型) 作为核心被控 - location.proto, 对应的 TOPIC 为 ``LOCATION`` - vehState.proto, 对应的 TOPIC 为 ``VEHICLE_STATE`` -对应 protobuf 的详细字段参考 [仿真消息说明文档](./403.仿真消息说明.md#3-仿真消息说明) 的定义. +对应 protobuf 的详细字段参考 [403.仿真消息说明](./403.仿真消息说明.md#3-仿真消息说明) 的定义. diff --git "a/docs/user_guidelines/user_guidelines_desktop/source/306.\344\274\240\346\204\237\345\231\250\344\273\277\347\234\237.md" "b/docs/user_guidelines/user_guidelines_desktop/source/306.\344\274\240\346\204\237\345\231\250\344\273\277\347\234\237.md" index 33fbc155..5f88dff5 100644 --- "a/docs/user_guidelines/user_guidelines_desktop/source/306.\344\274\240\346\204\237\345\231\250\344\273\277\347\234\237.md" +++ "b/docs/user_guidelines/user_guidelines_desktop/source/306.\344\274\240\346\204\237\345\231\250\344\273\277\347\234\237.md" @@ -505,7 +505,7 @@ TAD Sim 支持真值传感器仿真, 平台提供默认配置参数, 并支持 ### 6.5.2 数据获取 打开 SensotTruth 模块, 模块将广播过滤后的 traffic 消息 .Topic: ``TXSIM_SENSOR_OBJECT``, 依赖camera、lidar、ultrasonic 传感器, 如果指定了 -device, topic 为 ``TXSIM_SENSOR_OBJECT_{id}``. -详细信息见 [TAD Sim系统消息定义](https://doc.weixin.qq.com/sheet/e3_AYIAKQZaABoLqLUV4KmRMeXIjEXUu?scode=AJEAIQdfAAoRpj2akxAYIAKQZaABo&tab=mwzam3) +详细信息见 [403.仿真消息说明](./403.仿真消息说明.md#3-仿真消息说明) 的定义. ## 6.6 IMU 仿真 diff --git "a/docs/user_guidelines/user_guidelines_desktop/source/403.\344\273\277\347\234\237\346\266\210\346\201\257\350\257\264\346\230\216.md" "b/docs/user_guidelines/user_guidelines_desktop/source/403.\344\273\277\347\234\237\346\266\210\346\201\257\350\257\264\346\230\216.md" index 25e2558f..5c8b19a7 100644 --- "a/docs/user_guidelines/user_guidelines_desktop/source/403.\344\273\277\347\234\237\346\266\210\346\201\257\350\257\264\346\230\216.md" +++ "b/docs/user_guidelines/user_guidelines_desktop/source/403.\344\273\277\347\234\237\346\266\210\346\201\257\350\257\264\346\230\216.md" @@ -1,3 +1,3 @@ # 3. 仿真消息说明 -见 [腾讯文档 TAD_Sim 消息说明](https://doc.weixin.qq.com/sheet/e3_AYIAKQZaABoSjqd81bFQWODMbOrxX?scode=AJEAIQdfAAok7l0rAy) +见 [腾讯文档 TAD_Sim 消息说明](https://doc.weixin.qq.com/sheet/e3_AVwAKQaaAB480BcFBYISxG1eFNjZE?scode=AEwA3wKoAGM30VymmLAVwAKQaaAB4%3FnewPad%3D1&tab=njdi31)