Skip to content

Commit 254d434

Browse files
committed
docs: 添加Xinference镜像使用文档及构建产物
1 parent 811e0f9 commit 254d434

File tree

287 files changed

+48006
-138
lines changed

Some content is hidden

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

287 files changed

+48006
-138
lines changed

docs/README_XINFERENCE_IMAGE.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# Xinference 镜像使用文档
2+
3+
本文档是从 `Xinference 镜像使用.docx` 转换而来的 Sphinx 格式文档。
4+
5+
## 文档内容
6+
7+
该文档包含了以下内容:
8+
9+
- **Nvidia系列**:CUDA环境下的Xinference镜像使用指南
10+
- **MindIE系列**:华为昇腾NPU环境下的使用说明
11+
- **海光系列**:海光DCU环境下的部署方法
12+
- **证书更新**:Xinf企业版证书管理
13+
- **性能测试**:benchmark测试工具使用
14+
- **多机部署**:Supervisor和Worker集群部署配置
15+
- **链路日志**:基于Langfuse的调用链路追踪和监控
16+
- **K8s部署**:Kubernetes环境下的Helm部署配置
17+
18+
## 文件结构
19+
20+
```
21+
docs/
22+
├── source/
23+
│ ├── xinference_images/ # 镜像使用文档目录
24+
│ │ ├── index.rst # 镜像使用总览页面
25+
│ │ ├── nvidia.rst # Nvidia系列镜像
26+
│ │ ├── mindie.rst # MindIE系列镜像
27+
│ │ ├── hygon.rst # 海光系列镜像
28+
│ │ ├── license.rst # 证书更新
29+
│ │ ├── performance.rst # 性能测试
30+
│ │ ├── multi_deployment.rst # 多机部署
31+
│ │ ├── langfuse.rst # 链路日志
32+
│ │ └── kubernetes.rst # K8s部署
33+
│ ├── index.rst # 文档主索引
34+
│ └── conf.py # Sphinx配置文件
35+
├── build/html/ # 生成的HTML文档
36+
└── Makefile # 构建脚本
37+
```
38+
39+
## 构建文档
40+
41+
### 1. 安装依赖
42+
43+
```bash
44+
pip install sphinx sphinx-tabs sphinx-design pydata-sphinx-theme python-docx
45+
```
46+
47+
### 2. 构建HTML文档
48+
49+
```bash
50+
cd docs
51+
make html
52+
```
53+
54+
### 3. 查看文档
55+
56+
构建完成后,可以通过以下方式查看文档:
57+
58+
```bash
59+
# 启动本地服务器
60+
cd build/html
61+
python -m http.server 8080
62+
```
63+
64+
然后在浏览器中访问 `http://localhost:8080`
65+
66+
## 文档特性
67+
68+
-**模块化结构**:每个硬件平台独立页面,便于维护和查找
69+
-**导航友好**:清晰的目录结构和页面间交叉引用
70+
- ✅ 使用 reStructuredText 格式,符合 Sphinx 标准
71+
- ✅ 包含完整的代码块高亮显示
72+
- ✅ 支持多级目录结构和交叉引用
73+
- ✅ 包含警告和注意事项的特殊标记
74+
- ✅ 表格和列表格式化
75+
- ✅ 响应式设计,支持移动端查看
76+
77+
## 原始文档信息
78+
79+
- 原始文件:`Xinference 镜像使用.docx`
80+
- 转换时间:2025-09-25
81+
- 转换工具:python-docx + 手工整理
82+
- 文档格式:reStructuredText (.rst)
83+
84+
## 维护说明
85+
86+
如需更新文档内容:
87+
88+
1. 修改对应的 `.rst` 文件:
89+
- `source/xinference_images/nvidia.rst` - Nvidia系列
90+
- `source/xinference_images/mindie.rst` - MindIE系列
91+
- `source/xinference_images/hygon.rst` - 海光系列
92+
- `source/xinference_images/license.rst` - 证书管理
93+
- `source/xinference_images/performance.rst` - 性能测试
94+
- `source/xinference_images/multi_deployment.rst` - 多机部署
95+
- `source/xinference_images/langfuse.rst` - 链路日志
96+
- `source/xinference_images/kubernetes.rst` - K8s部署
97+
2. 运行 `make html` 重新构建
98+
3. 检查生成的HTML文档确保格式正确
99+
100+
## 注意事项
101+
102+
- 文档中包含的镜像拉取凭据仅为示例,实际使用时请使用正确的凭据
103+
- K8s部署配置需要根据实际环境进行调整
104+
- 性能测试结果会因硬件环境而异
70.4 KB
Binary file not shown.
10.4 KB
Binary file not shown.
3.33 KB
Binary file not shown.
28.8 KB
Binary file not shown.

docs/build/doctrees/index.doctree

4 KB
Binary file not shown.
12.7 KB
Binary file not shown.
18.1 KB
Binary file not shown.
21.4 KB
Binary file not shown.
47.8 KB
Binary file not shown.

0 commit comments

Comments
 (0)