master

ascend-robot[doc server] 添加文档托管网站基础设施

ca154a61创建于 4月24日历史提交

文件	最后提交记录	最后更新时间
figures	[文档]刷新总仓README中描述，和部分md文档格式问题 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !475 merge dev into dev [文档]刷新总仓README中描述，和部分md文档格式问题 Created-by: ella07 Commit-by: xiechangxiu;ella07 Merged-by: ascend-robot Description: Fixes [#246] 修改点如下： 1、总仓REAME.md中，环境部署的安装指南链接已过时，同时需补充上编译指导的链接。同时删除已过时的安装指南。 2、精简总仓REAME.md中简介和目录结构，简介中不提供架构图了 3、在doc/zh/user_guide/user_manual中，新增简介md，详细介绍LLM组件，并提供架构图。 4、修改两个md文档（准备软件包和依赖、镜像部署方式）的文字显示样式不正确，有多余的横线。 See merge request: Ascend/MindIE-LLM!475	2 个月前
compatibility_tool_configuration.md	[Doc]修改测试问题和工具低错 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !899 merge dev into dev [Doc]修改测试问题和工具低错 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#522](https://gitcode.com/Ascend/MindIE-LLM/issues/522) 1、修改大模型工具扫描的低错问题 2、修改部分测试问题，主要是安装目录变更、表格和json格式问题 3、maxBatchSize参数，增加300I Duo的取值说明 See merge request: Ascend/MindIE-LLM!899	1 个月前
environment_variable.md	[doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !822 merge dev into dev [doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#424](https://gitcode.com/Ascend/MindIE-LLM/issues/424) 1、平移社区安装指南中的安全加固，附录和faq。 2、修改大模型和AIDD工具的低错问题。 3、修改服务化config的路径 See merge request: Ascend/MindIE-LLM!822	1 个月前
introduction.md	[Doc]修改测试问题和工具低错 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !899 merge dev into dev [Doc]修改测试问题和工具低错 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#522](https://gitcode.com/Ascend/MindIE-LLM/issues/522) 1、修改大模型工具扫描的低错问题 2、修改部分测试问题，主要是安装目录变更、表格和json格式问题 3、maxBatchSize参数，增加300I Duo的取值说明 See merge request: Ascend/MindIE-LLM!899	1 个月前
introduction_to_manual_cpu_binding_for_virtual_machines.md	[doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !822 merge dev into dev [doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#424](https://gitcode.com/Ascend/MindIE-LLM/issues/424) 1、平移社区安装指南中的安全加固，附录和faq。 2、修改大模型和AIDD工具的低错问题。 3、修改服务化config的路径 See merge request: Ascend/MindIE-LLM!822	1 个月前
logging_configuration.md	[doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !822 merge dev into dev [doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#424](https://gitcode.com/Ascend/MindIE-LLM/issues/424) 1、平移社区安装指南中的安全加固，附录和faq。 2、修改大模型和AIDD工具的低错问题。 3、修改服务化config的路径 See merge request: Ascend/MindIE-LLM!822	1 个月前
menu_user_manual.md	[doc server] 添加文档托管网站基础设施 Co-authored-by: xuchi<xuchicolson@163.com> # message auto-generated for no-merge-commit merge: !724 merge A00200_0330 into dev [doc server] 添加文档托管网站基础设施 Created-by: martinXuc Commit-by: xuchi Merged-by: ascend-robot Description: <!-- PR描述模板更新日期：20251225 --> # 合入背景 Fixes #377 当前项目缺少统一的文档站点构建与发布能力，文档以原始 Markdown 形式放在仓库中，阅读体验差、导航结构不清晰，在线浏览和搜索功能非常有限。 本 PR 引入 MkDocs Material 文档站点基础设施，支持通过 ReadTheDocs 在线发布中文文档，同时修复文档链接、适配 pre-commit 检查、优化代码块渲染，为后续文档持续维护和协作提供标准化框架。 # 修改内容 ## 文档站点基础设施 1. 新增 [mkdocs.yml](mkdocs.yml) 站点配置文件，基于 MkDocs Material 主题，配置导航、搜索、代码高亮、Git 修订日期、图片灯箱、HTML 压缩、MathJax 数学公式渲染等插件和 Markdown 扩展 2. 新增 [.readthedocs.yaml](.readthedocs.yaml) ReadTheDocs 构建配置，使用 Ubuntu 22.04 + Python 3.11 + uv 包管理器进行文档构建 3. 新增 [requirements/mkdocs.txt](requirements/mkdocs.txt) 文档构建依赖清单 4. 新增 [docs/zh/.nav.yml](docs/zh/.nav.yml) 中文文档导航配置，覆盖用户指南、开发者指南和 FAQ 等模块 5. 新增 [docs/zh/build_mkdocs.md](docs/zh/build_mkdocs.md) 本地构建 MkDocs 文档服务的调试指南 ## 自定义样式与 Hook 6. 新增 [docs/mkdocs/hooks/github_admonition.py](docs/mkdocs/hooks/github_admonition.py) Hook，将 GitHub 风格的 > [!NOTE] 等 Admonition 语法自动转换为 MkDocs !!! note 语法（支持 >- 列表嵌套语法） 7. 新增 [docs/mkdocs/hooks/img_width.py](docs/mkdocs/hooks/img_width.py) Hook，将 HTML <img> 标签（含 width 属性）转换为 MkDocs 兼容的 Markdown 图片语法 8. 新增 [docs/zh/stylesheets/extra.css](docs/zh/stylesheets/extra.css) 自定义样式：定义 announcement、important、code、console 四种 Admonition 类型样式，Tabbed 组件样式，代码块系统等宽字体（不换行 + tab-size: 8） 9. 新增 [docs/zh/javascripts/mathjax.js](docs/zh/javascripts/mathjax.js) MathJax 数学公式渲染配置 ## README 与首页 10. 重构 [README.md](README.md)：添加居中大标题和副标题、导航栏（昇腾社区 / 文档中心 / 代码仓库 / 社区会议），所有文档链接替换为 ReadTheDocs 在线地址，修复原有 2 个断链（install/README.md、user_manual/README.md） 11. 重构 [docs/zh/README.md](docs/zh/README.md) 首页为 Landing Page，包含项目简介、核心能力、架构概览和相关链接 ## 文档修复与整理 12. 修复 [docs/zh/user_guide/install/menu_install.md](docs/zh/user_guide/install/menu_install.md) 中 4 处链接失效：nofification 拼写错误、FAQ 路径 faq/ → faq_and_appendixes/ 13. 修复 [docs/zh/user_guide/feature/](docs/zh/user_guide/feature/) 文件名大小写不一致：multi_loRA.md → multi_lora.md、splitFuse.md → split_fuse.md，同步更新所有引用该文件的导航链接 14. 删除冗余文档 installtion_in_containerized.md（保留 installation_in_containerized.md） ## Pre-commit 适配 15. [.pre-commit-config.yaml](.pre-commit-config.yaml) 中 check-yaml 添加 exclude: mkdocs\.yml$，跳过含 !!python/name: 扩展标签的 mkdocs.yml # 资料变更 本 PR 即为资料变更。引入 MkDocs 文档站点基础设施，重构中文文档首页和项目 README，修复多处文档链接失效，新增导航配置、自定义样式、MkDocs Hook 和 ReadTheDocs 构建配置。 # 接口变更 不涉及 # 测试结果 - 本地使用 mkdocs serve 构建验证通过，站点可正常访问，页面渲染正确 - 导航链接已逐一确认，所有页面可正常跳转 - 明暗主题切换正常，Logo 和 favicon 显示正确 - GitHub Admonition Hook 转换验证通过，> [!NOTE]、> [!WARNING]、> [!TIP]、> [!CAUTION]、> [!IMPORTANT] 均可正确转换（含 >- 列表嵌套语法） - 代码块系统等宽字体渲染正常，box-drawing 字符对齐正确（Mac / Windows / ReadTheDocs 已验证） - 搜索功能正常，支持中文搜索和高亮 - ReadTheDocs 构建配置验证通过 - pre-commit 检查通过（mkdocs.yml 已排除 check-yaml） # CheckList - [x] 代码注释完备 - [x] 正确记录错误日志 - [x] 进行了返回值校验 (禁止使用void屏蔽安全函数、自研函数返回值；考虑接口的异常场景；调用底层组件接口时，需要进行返回值校验) - [x] 进行了空指针校验 - [x] 若存在资源申请，使用后资源被正确的释放了 - [x] 若涉及多线程场景，考虑了并发场景，不存在死锁问题 - [x] 按照[代码仓中提供的格式模板](https://gitcode.com/Ascend/MindIE-LLM/blob/master/.clang-format)，使用clang-format工具格式化代码 - [x] 符合Ascend社区的编码规范。[C++ 语言编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Coding-Style-Guide.md) | [C++ 语言安全编程指导](https://gitcode.com/Ascend/community/blob/master/docs/contributor/Ascend-Cpp-Secure-Coding-Guide.md) See merge request: Ascend/MindIE-LLM!724	1 个月前
model_parameter_configuration.md	[Doc]修改测试问题和工具低错 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !899 merge dev into dev [Doc]修改测试问题和工具低错 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#522](https://gitcode.com/Ascend/MindIE-LLM/issues/522) 1、修改大模型工具扫描的低错问题 2、修改部分测试问题，主要是安装目录变更、表格和json格式问题 3、maxBatchSize参数，增加300I Duo的取值说明 See merge request: Ascend/MindIE-LLM!899	1 个月前
offline_inference.md	[doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !822 merge dev into dev [doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#424](https://gitcode.com/Ascend/MindIE-LLM/issues/424) 1、平移社区安装指南中的安全加固，附录和faq。 2、修改大模型和AIDD工具的低错问题。 3、修改服务化config的路径 See merge request: Ascend/MindIE-LLM!822	1 个月前
performance_tuning.md	[doc ]修改doc tools工具扫描出来的低错问题 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !708 merge dev into dev [doc ]修改doc tools工具扫描出来的低错问题 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#360](https://gitcode.com/Ascend/MindIE-LLM/issues/360) Doc tools工具问题清零。 See merge request: Ascend/MindIE-LLM!708	1 个月前
prefill_decode_mixed_deployment.md	[Doc]修改测试问题和工具低错 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !899 merge dev into dev [Doc]修改测试问题和工具低错 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#522](https://gitcode.com/Ascend/MindIE-LLM/issues/522) 1、修改大模型工具扫描的低错问题 2、修改部分测试问题，主要是安装目录变更、表格和json格式问题 3、maxBatchSize参数，增加300I Duo的取值说明 See merge request: Ascend/MindIE-LLM!899	1 个月前
rank_table_file_configuration.md	[doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !822 merge dev into dev [doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#424](https://gitcode.com/Ascend/MindIE-LLM/issues/424) 1、平移社区安装指南中的安全加固，附录和faq。 2、修改大模型和AIDD工具的低错问题。 3、修改服务化config的路径 See merge request: Ascend/MindIE-LLM!822	1 个月前
service_APIs_usage_guidance.md	[doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !822 merge dev into dev [doc]修改服务化config的路径、大模型和AIDD工具低错，平移社区安装指南中的安全加固 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#424](https://gitcode.com/Ascend/MindIE-LLM/issues/424) 1、平移社区安装指南中的安全加固，附录和faq。 2、修改大模型和AIDD工具的低错问题。 3、修改服务化config的路径 See merge request: Ascend/MindIE-LLM!822	1 个月前
service_parameter_configuration.md	[Doc]修改测试问题和工具低错 Co-authored-by: xiechangxiu<xiechangxiu3@h-partners.com> # message auto-generated for no-merge-commit merge: !899 merge dev into dev [Doc]修改测试问题和工具低错 Created-by: ella07 Commit-by: x60087760;ella07;xiechangxiu Merged-by: ascend-robot Description: [#522](https://gitcode.com/Ascend/MindIE-LLM/issues/522) 1、修改大模型工具扫描的低错问题 2、修改部分测试问题，主要是安装目录变更、表格和json格式问题 3、maxBatchSize参数，增加300I Duo的取值说明 See merge request: Ascend/MindIE-LLM!899	1 个月前