已关闭
[Documentation|文档反馈]:dsl文档 python package 打包相关说明未更新,且无序列表缩进不兼容 mkdocs 渲染 #545
yuantao创建于  18 天前关闭于  17 天前
yuantao
yuantao成员
18 天前 创建

Issues Section / 问题文档片段 (Mandatory / 必填)

DSL 已提供 python package 打包能力,但 python/tla_dsl/README.md 及 docs/zh/ 下构建相关章节的说明未随之更新,描述内容与当前实际能力存在偏差。

同时,DSL 多数文档的无序列表统一采用 2 空格缩进,而文档站使用的 mkdocs 仅支持 4 空格缩进,导致列表层级在渲染后无法正确呈现。

Existing Issues / 存在的问题 (Optional / 选填)

  1. 文档表述滞后:python package 打包功能已上线,但 README 与构建指南(build_guide)中对应的说明、步骤未同步,使用者按文档操作容易产生误解。
  2. 缩进不兼容:无序列表使用 2 空格缩进,mkdocs 仅识别 4 空格,文档站浏览时列表层级展平、可读性下降。
  3. 环境与配置说明缺失/不一致:构建、环境、测试等相关章节内容分散或缺失,缺少 .editorconfig 等统一格式化约束,易反复引入同类排版问题。

Expected / 期望结果 (Optional / 选填)

  • 同步更新 python package 打包相关文档表述,与实际能力保持一致;
  • 统一将无序列表缩进刷新为 4 空格,保证 mkdocs 文档站渲染效果;
  • 补齐并整理环境配置、构建与测试相关说明,补充 .editorconfig 约束缩进风格。
likedislike
yuantaoyuantao成员
18 天前 将 yuantao_ 设为负责人
longjihuilongjihui成员
18 天前 添加了label:documentation
yuantaoyuantao成员
17 天前 issue状态由 进行中 改变为 已完成
yuantaoyuantao成员
17 天前 关闭了 issue
yuantaoyuantao成员
17 天前 删除了关联的pull request:docs(dsl): 优化DSL文档部分表述,修复无序列表的缩进问题
longjihui
longjihui成员
17 天前 评论:

该问题已修复,详见PR:https://gitcode.com/cann/catlass/pull/1233

likedislike