refactor api documentation structure
This commit is contained in:
19
docs/api/_tools/README.md
Normal file
19
docs/api/_tools/README.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# API 工具脚本
|
||||
|
||||
**类型**: `tool-index`
|
||||
|
||||
**描述**: 存放用于生成、审计和整理 API 文档的辅助脚本。
|
||||
|
||||
## 当前脚本
|
||||
|
||||
- `audit_api_docs.py` - 审计链接、头文件引用与覆盖率
|
||||
- `generate_parallel_canonical_pages.py` - 统一生成 `docs/api/XCEngine/**` 下的 canonical 类型页与方法页
|
||||
- `generate_core_resources_canonical_pages.py` - canonical 生成实现脚本
|
||||
- `scaffold_parallel_layout.py` - 生成与源码平行的目录总览页
|
||||
- `migrate_canonical_pages_to_class_dirs.py` - 将旧的 flat header 页面迁移到 `{TypeName}/{TypeName}.md`
|
||||
- `fix_links.py` - 扫描并修复 Markdown 相对链接
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [API 总索引](../main.md)
|
||||
- [API 文档重构状态](../_meta/rebuild-status.md)
|
||||
Reference in New Issue
Block a user