v3.0.0

ascend-robot[Docs][RTD]Fix ReadTheDocs build to use zh/en source directories

b7297f6b创建于 5月14日历史提交

文件	最后提交记录	最后更新时间
_static	[Docs] Optimize document Chinese and English switching experience Co-authored-by: blian6<bin.lian@outlook.com> Co-authored-by: blian<lianbin@huawei.com> # message auto-generated for no-merge-commit merge: !267 merge dev into dev [Docs] Optimize document Chinese and English switching experience Created-by: blian Commit-by: blian6;blian Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 1. 优化文档内容，并提供网页的中英文切换能力 2. 添加关键融合算子和关键API的说明文档 3. 后续优化点： a. 图片的路径需要移到公有路径(docs/figures)，否则，会产生无法找到的问题，但是这个修改涉及面较多，后续提交PR。 b. 中文界面的切换按钮最好是英文。 # Purpose # Test Plan 本地生成 HTML 文档可使用以下命令： bash python -m pip install -r docs/requirements-docs.txt # 构建中英文 python docs/build_docs.py # 仅构建中文 SPHINX_LANGUAGE=zh sphinx-build -b html -c docs docs/zh docs/_build/zh/html # 仅构建英文 SPHINX_LANGUAGE=en sphinx-build -b html -c docs docs/en docs/_build/en/html 本地预览方法： python -m http.server 8080 --directory docs/_build - http://localhost:8080 → 自动跳转中文版 - http://localhost:8080/zh/html/index.html → 中文 - http://localhost:8080/en/html/index.html → 英文 # Test Report   See merge request: Ascend/MindIE-SD!267	2 个月前
_templates	[Docs][RTD]Fix ReadTheDocs build to use zh/en source directories Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !293 merge rtd_0513 into dev [Docs][RTD]Fix ReadTheDocs build to use zh/en source directories Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 无关issue，仅修正文档服务 # Purpose - 修复 ReadTheDocs 因python版本和Sphinx版本不匹配导致无法构建的问题。 修改内容： 1. .readthedocs.yaml：改用 python3.11 - 修复 ReadTheDocs 构建的文档首页显示英文目录而非中文目录的问题。 根因：ReadTheDocs 默认使用 docs/ 作为 Sphinx 源目录，首页渲染的是 docs/index.md，其 toctree caption 为英文（"Getting Started"、"User Guide" 等）。而中文首页 docs/zh/index.md 的 toctree caption 为中文（"快速开始"、"加速特性" 等），但 ReadTheDocs 未以其为构建源目录。 修改内容： 1. .readthedocs.yaml：改用 build.commands 自定义构建，分别用 docs/zh/ 和 docs/en/ 作为源目录构建中文和英文文档，根入口重定向到中文首页 2. docs/conf.py：根据 READTHEDOCS 环境变量动态设置语言切换器 URL，适配 ReadTheDocs 与本地构建的不同输出路径 3. docs/_templates/language-switcher.html 及其组件：改进 JS 路径解析，同时支持本地构建的 /html/ 路径和 ReadTheDocs 的 /zh/、/en/ 路径 # Test Plan 1. 合并后触发 ReadTheDocs 构建，观察构建日志是否成功 2. 访问 https://mindie-sd-docs.readthedocs.io/zh-cn/latest/ 确认自动跳转到中文首页 3. 检查中文首页左侧目录是否为中文标题（"快速开始"、"加速特性" 等） 4. 检查英文首页左侧目录是否为英文标题（"Getting Started"、"Feature Guides" 等） 5. 验证语言切换器在中英文页面间正确跳转 # Test Report https://mindie-sd-docs.readthedocs.io/zh-cn/latest/zh/index.html See merge request: Ascend/MindIE-SD!293	1 个月前
en	[Docs]统一图片资源命名规范并迁移至公共目录 Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !282 merge pic_rename into dev [Docs]统一图片资源命名规范并迁移至公共目录 Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: ## 变更摘要 规范化 docs/ 目录下全部图片资源的命名方式，并将其从语言专属目录迁移到公共目录，便于中英文文档共享引用。 ## 具体变更 - **重命名 34 个图片文件**：将 docs/zh/figures 下的中文/混合命名统一改为英文 snake_case 格式。 - 示例：CFG并行.png → cfg_parallel.png - 示例：单卡base + 高性能FA算子.gif → single_card_base_fa.gif - **迁移图片目录**：从 docs/zh/figures/ 移动到 docs/figures/，消除语言路径耦合。 - **更新 15 篇文档引用**：覆盖 docs/zh/、docs/en/ 及 README.md 中的图片路径与文件名，同时修复了 Markdown 中 URL 编码的中文文件名引用。 ## 涉及的文件 - README.md - docs/zh/*.md、docs/zh/features/*.md - docs/en/*.md、docs/en/features/*.md ## 验证结果 - 已确认所有 Markdown 图片引用中不再包含中文字符。 - 已确认仓库中不存在残留的 zh/figures 旧路径引用。 See merge request: Ascend/MindIE-SD!282	1 个月前
figures	[Docs]统一图片资源命名规范并迁移至公共目录 Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !282 merge pic_rename into dev [Docs]统一图片资源命名规范并迁移至公共目录 Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: ## 变更摘要 规范化 docs/ 目录下全部图片资源的命名方式，并将其从语言专属目录迁移到公共目录，便于中英文文档共享引用。 ## 具体变更 - **重命名 34 个图片文件**：将 docs/zh/figures 下的中文/混合命名统一改为英文 snake_case 格式。 - 示例：CFG并行.png → cfg_parallel.png - 示例：单卡base + 高性能FA算子.gif → single_card_base_fa.gif - **迁移图片目录**：从 docs/zh/figures/ 移动到 docs/figures/，消除语言路径耦合。 - **更新 15 篇文档引用**：覆盖 docs/zh/、docs/en/ 及 README.md 中的图片路径与文件名，同时修复了 Markdown 中 URL 编码的中文文件名引用。 ## 涉及的文件 - README.md - docs/zh/*.md、docs/zh/features/*.md - docs/en/*.md、docs/en/features/*.md ## 验证结果 - 已确认所有 Markdown 图片引用中不再包含中文字符。 - 已确认仓库中不存在残留的 zh/figures 旧路径引用。 See merge request: Ascend/MindIE-SD!282	1 个月前
tech_report	[Docs] refresh lint and dependency config, docker, docs Co-authored-by: weixin_44144262<lijinxi2@huawei.com> # message auto-generated for no-merge-commit merge: !243 merge dev into dev [Docs] refresh lint and dependency config, docker, docs Created-by: weixin_44144262 Commit-by: weixin_44144262 Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes > Fix part of #72 # Purpose This PR delivers five grouped changes: 1. add a 910B AArch64 docker build environment; 2. refresh repository lint/dependency inputs; 3. reorganize developer documentation and navigation; 4. align homepage, manuals, and tech report entrypoints; 5. consolidate governance skill routing and require proactive commit/PR draft output. # Test Plan 1. Review the new docker build files and README. 2. Review repository dependency and pre-commit configuration changes. 3. Review Chinese and English developer guide updates and navigation entrypoints. 4. Review homepage/manual/report entry changes. 5. Review AGENTS.md and .agents/skills/mindie-sd-community-governance/SKILL.md for routing and PR-drafting requirements. # Test Report  See merge request: Ascend/MindIE-SD!243	2 个月前
zh	[Docs]Fix release note formatting and dependency version description Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !291 merge releasenote-0512 into dev [Docs]Fix release note formatting and dependency version description Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 无关issue，仅修正release note # Purpose 修正 docs/zh/release_note.md 中的以下问题： 1. 将 Ascend HDK 和 Torch 的具体版本号删除，改为引用 CANN 版本配套说明链接，避免版本信息维护不一致。 2. 删除兼容性表格中多余的 Torch 列，精简版本配套表。 3. 修正新增特性第 6 条前的全角竖线 ｜6 为半角 | 6，修复 Markdown 表格格式。 4. 删除文档末尾多余的空标题 # 3.0.0版本配套文档。 # Test Plan - 本地预览 docs/zh/release_note.md Markdown 渲染效果，确认表格格式正确。 - （建议）执行文档站点编译验证： ```bash python -m pip install -r docs/requirements-docs.txt python -m sphinx -b html docs docs/_build/html See merge request: Ascend/MindIE-SD!291	1 个月前
build_docs.py	[Docs] Optimize document Chinese and English switching experience Co-authored-by: blian6<bin.lian@outlook.com> Co-authored-by: blian<lianbin@huawei.com> # message auto-generated for no-merge-commit merge: !267 merge dev into dev [Docs] Optimize document Chinese and English switching experience Created-by: blian Commit-by: blian6;blian Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 1. 优化文档内容，并提供网页的中英文切换能力 2. 添加关键融合算子和关键API的说明文档 3. 后续优化点： a. 图片的路径需要移到公有路径(docs/figures)，否则，会产生无法找到的问题，但是这个修改涉及面较多，后续提交PR。 b. 中文界面的切换按钮最好是英文。 # Purpose # Test Plan 本地生成 HTML 文档可使用以下命令： bash python -m pip install -r docs/requirements-docs.txt # 构建中英文 python docs/build_docs.py # 仅构建中文 SPHINX_LANGUAGE=zh sphinx-build -b html -c docs docs/zh docs/_build/zh/html # 仅构建英文 SPHINX_LANGUAGE=en sphinx-build -b html -c docs docs/en docs/_build/en/html 本地预览方法： python -m http.server 8080 --directory docs/_build - http://localhost:8080 → 自动跳转中文版 - http://localhost:8080/zh/html/index.html → 中文 - http://localhost:8080/en/html/index.html → 英文 # Test Report   See merge request: Ascend/MindIE-SD!267	2 个月前
conf.py	[Docs][RTD]Fix ReadTheDocs build to use zh/en source directories Co-authored-by: changetheway<guotaoyuan1@h-partners.com> # message auto-generated for no-merge-commit merge: !293 merge rtd_0513 into dev [Docs][RTD]Fix ReadTheDocs build to use zh/en source directories Created-by: changetheway Commit-by: changetheway Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes 无关issue，仅修正文档服务 # Purpose - 修复 ReadTheDocs 因python版本和Sphinx版本不匹配导致无法构建的问题。 修改内容： 1. .readthedocs.yaml：改用 python3.11 - 修复 ReadTheDocs 构建的文档首页显示英文目录而非中文目录的问题。 根因：ReadTheDocs 默认使用 docs/ 作为 Sphinx 源目录，首页渲染的是 docs/index.md，其 toctree caption 为英文（"Getting Started"、"User Guide" 等）。而中文首页 docs/zh/index.md 的 toctree caption 为中文（"快速开始"、"加速特性" 等），但 ReadTheDocs 未以其为构建源目录。 修改内容： 1. .readthedocs.yaml：改用 build.commands 自定义构建，分别用 docs/zh/ 和 docs/en/ 作为源目录构建中文和英文文档，根入口重定向到中文首页 2. docs/conf.py：根据 READTHEDOCS 环境变量动态设置语言切换器 URL，适配 ReadTheDocs 与本地构建的不同输出路径 3. docs/_templates/language-switcher.html 及其组件：改进 JS 路径解析，同时支持本地构建的 /html/ 路径和 ReadTheDocs 的 /zh/、/en/ 路径 # Test Plan 1. 合并后触发 ReadTheDocs 构建，观察构建日志是否成功 2. 访问 https://mindie-sd-docs.readthedocs.io/zh-cn/latest/ 确认自动跳转到中文首页 3. 检查中文首页左侧目录是否为中文标题（"快速开始"、"加速特性" 等） 4. 检查英文首页左侧目录是否为英文标题（"Getting Started"、"Feature Guides" 等） 5. 验证语言切换器在中英文页面间正确跳转 # Test Report https://mindie-sd-docs.readthedocs.io/zh-cn/latest/zh/index.html See merge request: Ascend/MindIE-SD!293	1 个月前
index.md	[Docs] refresh lint and dependency config, docker, docs Co-authored-by: weixin_44144262<lijinxi2@huawei.com> # message auto-generated for no-merge-commit merge: !243 merge dev into dev [Docs] refresh lint and dependency config, docker, docs Created-by: weixin_44144262 Commit-by: weixin_44144262 Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes > Fix part of #72 # Purpose This PR delivers five grouped changes: 1. add a 910B AArch64 docker build environment; 2. refresh repository lint/dependency inputs; 3. reorganize developer documentation and navigation; 4. align homepage, manuals, and tech report entrypoints; 5. consolidate governance skill routing and require proactive commit/PR draft output. # Test Plan 1. Review the new docker build files and README. 2. Review repository dependency and pre-commit configuration changes. 3. Review Chinese and English developer guide updates and navigation entrypoints. 4. Review homepage/manual/report entry changes. 5. Review AGENTS.md and .agents/skills/mindie-sd-community-governance/SKILL.md for routing and PR-drafting requirements. # Test Report  See merge request: Ascend/MindIE-SD!243	2 个月前
requirements-docs.txt	[Docs] refresh lint and dependency config, docker, docs Co-authored-by: weixin_44144262<lijinxi2@huawei.com> # message auto-generated for no-merge-commit merge: !243 merge dev into dev [Docs] refresh lint and dependency config, docker, docs Created-by: weixin_44144262 Commit-by: weixin_44144262 Merged-by: ascend-robot Description: # Which issue(s) this PR fixes or accomplishes > Fix part of #72 # Purpose This PR delivers five grouped changes: 1. add a 910B AArch64 docker build environment; 2. refresh repository lint/dependency inputs; 3. reorganize developer documentation and navigation; 4. align homepage, manuals, and tech report entrypoints; 5. consolidate governance skill routing and require proactive commit/PR draft output. # Test Plan 1. Review the new docker build files and README. 2. Review repository dependency and pre-commit configuration changes. 3. Review Chinese and English developer guide updates and navigation entrypoints. 4. Review homepage/manual/report entry changes. 5. Review AGENTS.md and .agents/skills/mindie-sd-community-governance/SKILL.md for routing and PR-drafting requirements. # Test Report  See merge request: Ascend/MindIE-SD!243	2 个月前