| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
config sphinx Co-authored-by: unknown<liangxiaobo6@h-partners.com> # message auto-generated for no-merge-commit merge: !2212 merge master into master config sphinx Created-by: liangxiaob Commit-by: unknown Merged-by: cann-robot Description: ## 描述 为 Ascend C API 参考文档新增 Sphinx 构建基础设施，支持将 Markdown 文档自动转换为静态 HTML 网站，具备以下特性： - **自动化构建流程**：一键脚本生成目录结构（TOC）、构建 HTML、后处理验证 - **版本筛选功能**：支持全量/950 版本切换，侧边栏动态过滤 - **离线下载支持**：自动生成全量和 950 版本的离线文档 zip 包 ### 实现 新增 19 个文件（+6109 行），按功能分类： | 类别 | 文件 | 说明 | |------|------|------| | 构建脚本 | _gen_toc.py、_verify_html.py、_verify_toc.py、generate_zips.py | TOC 生成、HTML 验证、zip 打包 | | 配置文件 | conf.py、build.sh、_toc.yml | Sphinx 配置、一键构建 | | 前端脚本 | toc-toggle.js、version-filter.js、toc-data.js | 侧边栏导航、版本筛选 | | 样式模板 | custom.css、layout.html、download-button.html | 自定义样式、页面模板 | | 配置数据 | switcher.json、version_filter.json | 版本切换菜单、页面筛选映射 | ### 使用方式 bash # 一键构建 cd docs/api bash scripts/build.sh ### 构建产物 位于 _build/html/index.html ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #xxx--> ## 测试 - 本地构建验证通过 - HTML 输出结构正确 - 版本筛选功能正常 - 下载 zip 包生成成功 ## 文档更新 - 新增 docs/api/scripts/AscendC_Api_Auto_Gen_Html.md 构建指南 - 新增 docs/api/index.rst 文档首页 - 新增 docs/api/scripts 构建脚本 & 配置 - 新增 docs/api/_static css/js/json相关配置 - 新增 docs/api/_templates 布局样式 ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 fix: Bug 修复 - [ ] ✨ feat: 新功能 - [ ] ⚡ perf: 性能优化 - [ ] ♻️ refactor: 代码重构 - [ ] 🧪 test: 新增或修改测试 - [x] 📝 docs: 文档更新 - [ ] 🔧 ci: CI/CD 配置修改 - [ ] ↩️ revert: 回退 - [ ] 🧹 chore: 其他，请具体描述 See merge request: cann/asc-devkit!2212 | 1 个月前 | |
config sphinx Co-authored-by: unknown<liangxiaobo6@h-partners.com> # message auto-generated for no-merge-commit merge: !2212 merge master into master config sphinx Created-by: liangxiaob Commit-by: unknown Merged-by: cann-robot Description: ## 描述 为 Ascend C API 参考文档新增 Sphinx 构建基础设施，支持将 Markdown 文档自动转换为静态 HTML 网站，具备以下特性： - **自动化构建流程**：一键脚本生成目录结构（TOC）、构建 HTML、后处理验证 - **版本筛选功能**：支持全量/950 版本切换，侧边栏动态过滤 - **离线下载支持**：自动生成全量和 950 版本的离线文档 zip 包 ### 实现 新增 19 个文件（+6109 行），按功能分类： | 类别 | 文件 | 说明 | |------|------|------| | 构建脚本 | _gen_toc.py、_verify_html.py、_verify_toc.py、generate_zips.py | TOC 生成、HTML 验证、zip 打包 | | 配置文件 | conf.py、build.sh、_toc.yml | Sphinx 配置、一键构建 | | 前端脚本 | toc-toggle.js、version-filter.js、toc-data.js | 侧边栏导航、版本筛选 | | 样式模板 | custom.css、layout.html、download-button.html | 自定义样式、页面模板 | | 配置数据 | switcher.json、version_filter.json | 版本切换菜单、页面筛选映射 | ### 使用方式 bash # 一键构建 cd docs/api bash scripts/build.sh ### 构建产物 位于 _build/html/index.html ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #xxx--> ## 测试 - 本地构建验证通过 - HTML 输出结构正确 - 版本筛选功能正常 - 下载 zip 包生成成功 ## 文档更新 - 新增 docs/api/scripts/AscendC_Api_Auto_Gen_Html.md 构建指南 - 新增 docs/api/index.rst 文档首页 - 新增 docs/api/scripts 构建脚本 & 配置 - 新增 docs/api/_static css/js/json相关配置 - 新增 docs/api/_templates 布局样式 ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 fix: Bug 修复 - [ ] ✨ feat: 新功能 - [ ] ⚡ perf: 性能优化 - [ ] ♻️ refactor: 代码重构 - [ ] 🧪 test: 新增或修改测试 - [x] 📝 docs: 文档更新 - [ ] 🔧 ci: CI/CD 配置修改 - [ ] ↩️ revert: 回退 - [ ] 🧹 chore: 其他，请具体描述 See merge request: cann/asc-devkit!2212 | 1 个月前 | |
config sphinx Co-authored-by: unknown<liangxiaobo6@h-partners.com> # message auto-generated for no-merge-commit merge: !2212 merge master into master config sphinx Created-by: liangxiaob Commit-by: unknown Merged-by: cann-robot Description: ## 描述 为 Ascend C API 参考文档新增 Sphinx 构建基础设施，支持将 Markdown 文档自动转换为静态 HTML 网站，具备以下特性： - **自动化构建流程**：一键脚本生成目录结构（TOC）、构建 HTML、后处理验证 - **版本筛选功能**：支持全量/950 版本切换，侧边栏动态过滤 - **离线下载支持**：自动生成全量和 950 版本的离线文档 zip 包 ### 实现 新增 19 个文件（+6109 行），按功能分类： | 类别 | 文件 | 说明 | |------|------|------| | 构建脚本 | _gen_toc.py、_verify_html.py、_verify_toc.py、generate_zips.py | TOC 生成、HTML 验证、zip 打包 | | 配置文件 | conf.py、build.sh、_toc.yml | Sphinx 配置、一键构建 | | 前端脚本 | toc-toggle.js、version-filter.js、toc-data.js | 侧边栏导航、版本筛选 | | 样式模板 | custom.css、layout.html、download-button.html | 自定义样式、页面模板 | | 配置数据 | switcher.json、version_filter.json | 版本切换菜单、页面筛选映射 | ### 使用方式 bash # 一键构建 cd docs/api bash scripts/build.sh ### 构建产物 位于 _build/html/index.html ## 关联的Issue <!-- 如果这个PR是为了解决特定的Issue，请在这里提供Issue链接。例如：关联Issue #xxx--> ## 测试 - 本地构建验证通过 - HTML 输出结构正确 - 版本筛选功能正常 - 下载 zip 包生成成功 ## 文档更新 - 新增 docs/api/scripts/AscendC_Api_Auto_Gen_Html.md 构建指南 - 新增 docs/api/index.rst 文档首页 - 新增 docs/api/scripts 构建脚本 & 配置 - 新增 docs/api/_static css/js/json相关配置 - 新增 docs/api/_templates 布局样式 ## 类型标签 <!-- [x] 表示选中 --> - [ ] 🐛 fix: Bug 修复 - [ ] ✨ feat: 新功能 - [ ] ⚡ perf: 性能优化 - [ ] ♻️ refactor: 代码重构 - [ ] 🧪 test: 新增或修改测试 - [x] 📝 docs: 文档更新 - [ ] 🔧 ci: CI/CD 配置修改 - [ ] ↩️ revert: 回退 - [ ] 🧹 chore: 其他，请具体描述 See merge request: cann/asc-devkit!2212 | 1 个月前 |
| 文件 | 最后提交记录 | 最后更新时间 |
|---|---|---|
| 1 个月前 | ||
| 1 个月前 | ||
| 1 个月前 |