Skip to content

Commit 96c8b47

Browse files
Charliechen114514Charliechen114514
committed
update gitignores
1 parent cb2e52d commit 96c8b47

143 files changed

Lines changed: 1484 additions & 632 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/deploy.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -66,6 +66,22 @@ jobs:
6666
--output ./document/api \
6767
--config doxybook.json
6868
69+
# 6.5. 为自动生成的 API 文档配置导航
70+
- name: 配置 API 导航
71+
run: |
72+
cat > document/api/.pages <<'EOF'
73+
title: API 自动文档
74+
icon: material/file-document
75+
nav:
76+
- 命名空间: Namespaces
77+
- 类: Classes
78+
- 文件: Files
79+
EOF
80+
81+
# 6.6. 修复 doxybook2 生成的相对链接路径
82+
- name: 修复 API 文档链接
83+
run: python3 scripts/document/fix_doxybook_links.py
84+
6985
# 7. 构建网站
7086
- name: 构建网站
7187
run: mkdocs build --clean

‎.gitignore‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,11 @@ BLUEPRINT.md
1010
# native builds
1111
out/
1212

13+
# Documents summons
14+
xml/
15+
site/
16+
document/api/
17+
1318
# .vscode
1419
.vscode
1520

‎document/.pages‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
title: 首页
2+
nav:
3+
- HandBook
4+
- Development: development
5+
- Desktop: desktop
6+
- CI/CD: ci
7+
- Scripts: scripts
8+
- Design Stage: design_stage
9+
- Notes: notes
10+
- TODO: todo
11+
- Optimize: optimize
12+
- Release Rule: release_rule

‎document/HandBook/.pages‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
title: 开发手册
2+
icon: material/book-open-page-variant
3+
nav:
4+
- 基础工具库: base
5+
- 桌面模块: desktop
6+
- UI 框架: ui
7+
- API 参考: api
8+
- 平台实现: implementation
9+
- 示例: examples

‎document/HandBook/api/.pages‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
title: API 参考
2+
icon: material/api
3+
nav:
4+
- system

‎document/HandBook/api/index.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
1-
# api
1+
# API 参考
22

3-
> Welcome to the api section.
3+
本节包含由 Doxygen 自动生成的 C++ API 文档以及手动维护的接口说明。
44

5-
## Overview
5+
## 系统信息 API
66

7-
Documentation and resources for api.
7+
| 模块 | 说明 |
8+
|------|------|
9+
| [CPU](system/cpu/overview.md) | CPU 信息查询、频率分析、性能分析 |
10+
| [内存](system/memory/index.md) | 内存使用信息 |
811

9-
---
10-
11-
*Last updated: 2026-03-20*

‎document/HandBook/api/system/.pages‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
title: 系统信息
2+
nav:
3+
- CPU: cpu
4+
- 内存: memory

‎document/HandBook/api/system/cpu/.pages‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
title: CPU
2+
nav:
3+
- 概览: overview.md
4+
- CFCpu: cfcpu.md
5+
- CFCpu Bonus: cfcpu_bonus.md
6+
- 性能分析: cfcpu_profile.md

‎document/HandBook/api/system/cpu/cfcpu.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,4 +109,4 @@ int main() {
109109

110110
- [性能信息 API](./cfcpu_profile.md)
111111
- [扩展信息 API](./cfcpu_bonus.md)
112-
- [使用示例](../../examples/cpu_info_example.md)
112+
- [使用示例](../../../examples/cpu_info_example/)

‎document/HandBook/api/system/cpu/cfcpu_bonus.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,4 +151,4 @@ int main() {
151151

152152
- [基础信息 API](./cfcpu.md)
153153
- [性能信息 API](./cfcpu_profile.md)
154-
- [使用示例](../../examples/cpu_info_example.md)
154+
- [使用示例](../../../examples/cpu_info_example/)

0 commit comments

Comments
 (0)