已合并
docs(dsl): 优化DSL文档部分表述,修复无序列表的缩进问题 #1233
docs(dsl): 优化DSL文档部分表述,修复无序列表的缩进问题 #1233
已合并
yuantao创建于 22 天前
yuantao
yuantao成员
22 天前

描述

DSL提供了python package打包功能,但对应文档有部分未更新,容易产生误解,现统一修复,同时修复部分环境配置文件。
DSL多数文档使用两个空格缩进无序列表,但mkdocs仅支持4缩进,因此统一刷新,保证文档站观看效果

关联的Issue

#545
https://gitcode.com/cann/catlass/issues/545

原因

测试

文档更新

类型标签

likedislike
Pull Request已成功合入, 合并人@CANN-robot
(感谢 yuantao 的贡献)
yuantaoyuantao成员
22 天前 创建了 pull request,commit 63f6388e
CANN-robotCANN-robot成员
22 天前 添加了label:stat/needs-squash
CANN-robotCANN-robot成员
22 天前 添加了label:cann-cla/yes
CANN-robot
CANN-robot成员
22 天前 评论:

Thanks for your pull-request.
The full list of commands accepted by me can be found at here.
You can get sig-info at here.
You can self-configure the PR merge rules for this repository. For more details, please refer to Here.
For more, you also can visit HICANN.


PR Approval Progress

✅ Congratulations! All modules have met the lgtm and approve requirements.

Module Approval Details

module lgtm status approve status
repo-cann/catlass ✅ sunhao_hw, longjihui (2/2) ✅ sunhao_hw (1/1)

💡 Tip:

  • Committer can comment /approve or /lgtm
  • Commenting /approve implies both code review (lgtm) and intent to merge (approve)

CLA Signature Pass

yuantao_, thanks for your pull request. All authors of the commits have signed the CLA. 👍

likedislike
yuantaoyuantao成员
22 天前 预合并成功(commit_id: ac8e351e78a7195e0b60287fd6ae6c313dc826fa)
yuantaoyuantao成员
22 天前 强制推送  1 个提交:5f18e06e-docs(dsl): 拆分臃肿 index 为纯导航,对齐非 DSL 文档结构
yuantaoyuantao成员
22 天前 预合并成功(commit_id: 29ee1bfd72319e84bdbf1cfee8da1a486c02514c)
CANN-robotCANN-robot成员
22 天前 删除了label:cann-cla/yes
CANN-robotCANN-robot成员
22 天前 删除了label:stat/needs-squash
CANN-robot
CANN-robot成员
22 天前 评论:

Notification

This pull request has been changed(code update) or closed, so removes the following label(s): stat/needs-squash.

likedislike
CANN-robotCANN-robot成员
22 天前 添加了label:cann-cla/yes
yuantaoyuantao成员
21 天前 修改了pull request 的描述
yuantao
yuantao成员
21 天前 评论:

compile

likedislike
yuantaoyuantao成员
21 天前 预合并成功(commit_id: 104f4a9343e30ba5d54fc31141d1174b71a0c131)
CANN-robotCANN-robot成员
21 天前 添加了label:ci-pipeline-running
CANN-robotCANN-robot成员
21 天前 删除了label:ci-pipeline-running
CANN-robotCANN-robot成员
21 天前 添加了label:ci-pipeline-failed
CANN-robot
CANN-robot成员
21 天前 评论:
流水线 PR-pipeline_catlass#3316 [ commitID:5f18e06e ] 运行失败
>>>代码风格自动修复执行失败,具体请查看日志,不影响流水线执行及PR合入
阶段 任务名 状态 详情
编译构建 Build_arm 🟣 INIT >>>
恶意代码检查 Antipoison ✅ COMPLETED >>>
开源片段检查 SCA ✅ COMPLETED >>>
pre-commit pre-commit ❌ FAILED >>>
static_check_markdownlint ✅ COMPLETED >>>
static_check_link_validity ✅ COMPLETED >>>
static_check_resource_check ✅ COMPLETED >>>
static_check_codespell_check ✅ COMPLETED >>>
static_check_tag_closed_check ✅ COMPLETED >>>
开发者测试 UT_arm 🟣 INIT >>>
UT_IR_Test 🟣 INIT >>>
UT_lit_Test 🟣 INIT >>>
流水线 PR-pipeline_catlass ❌ FAILED >>>
此流水线已支持下列评论快捷指令,仅PR创建者和白名单成员[Zhang, Haobo, init__zhb__, tianxinghui, longjihui, yuantao_, sunhao_hw]评论有效
  • compile、/compile : 运行流水线
  • retry : 重试流水线所有失败子任务
  • retry <任务名> : 仅重试指定失败子任务
  • stop : 停止流水线
likedislike
yuantaoyuantao成员
21 天前 预合并成功(commit_id: 2cb979927cb91ca99bfd44eaaab654c49c58993a)
yuantaoyuantao成员
21 天前 强制推送  5 个提交:2ebd0658-3 commits from branch master,c3a032e7-docs(dsl): 拆分臃肿 index 为纯导航,对齐非 DSL 文档结构,5f4063bd-fix precommit
yuantaoyuantao成员
21 天前 预合并成功(commit_id: 8de02fb01c826a237331588e15e84026d3f1da26)
yuantao
yuantao成员
21 天前 评论:

compile

likedislike
yuantaoyuantao成员
21 天前 预合并成功(commit_id: 3533c35798f89665ca36ce91a4ae169a8894ed9e)
此处折叠了6条事件消息 查看更多
CANN-robotCANN-robot成员
21 天前 添加了label:ci-pipeline-passed
CANN-robot
CANN-robot成员
21 天前 评论:
流水线 PR-pipeline_catlass#3321 [ commitID:5f4063bd ] 已完成
>>>代码风格自动修复执行成功(无修复内容)
阶段 任务名 状态 详情
编译构建 Build_arm ✅ COMPLETED >>>
恶意代码检查 Antipoison ✅ COMPLETED >>>
开源片段检查 SCA ✅ COMPLETED >>>
pre-commit pre-commit ✅ COMPLETED >>>
static_check_markdownlint ✅ COMPLETED >>>
static_check_link_validity ✅ COMPLETED >>>
static_check_resource_check ✅ COMPLETED >>>
static_check_codespell_check ✅ COMPLETED >>>
static_check_tag_closed_check ✅ COMPLETED >>>
开发者测试 UT_arm ✅ COMPLETED >>>
UT_IR_Test ✅ COMPLETED >>>
UT_lit_Test ✅ COMPLETED >>>
流水线 PR-pipeline_catlass ✅ COMPLETED >>>
此流水线已支持下列评论快捷指令,仅PR创建者和白名单成员[Zhang, Haobo, init__zhb__, tianxinghui, longjihui, yuantao_, sunhao_hw]评论有效
  • compile、/compile : 运行流水线
  • retry : 重试流水线所有失败子任务
  • retry <任务名> : 仅重试指定失败子任务
  • stop : 停止流水线
likedislike
yuantaoyuantao成员
21 天前 取消了草稿状态
yuantao
yuantao成员
21 天前 评论:

文档修改,跳过RDV

likedislike
yuantaoyuantao成员
21 天前 添加了label:RDV-SUCC
longjihui
longjihui成员
21 天前 评论:

/lgtm

likedislike
sunhao_hw成员
21 天前 评论:

/lgtm
/approve

likedislike
CANN-robotCANN-robot成员
21 天前 添加了label:lgtmapproved
yuantao
yuantao成员
21 天前 评论:

/check-pr

likedislike
CANN-robotCANN-robot成员
21 天前 合入了pull request
yuantaoyuantao成员
21 天前 删除了关联的issue:[Documentation|文档反馈]:dsl文档 python package 打包相关说明未更新,且无序列表缩进不兼容 mkdocs 渲染
yuantaoyuantao成员
21 天前 关联了issue:[Documentation|文档反馈]: 直接使用environment.yml创建dsl环境出现ERROR报错
yuantaoyuantao成员
21 天前 删除了关联的issue:[Documentation|文档反馈]: 直接使用environment.yml创建dsl环境出现ERROR报错
yuantaoyuantao成员
21 天前 关联了issue:[Documentation|文档反馈]: 直接使用environment.yml创建dsl环境出现ERROR报错