diff --git a/docs/.vitepress/sidebar.ts b/docs/.vitepress/sidebar.ts index 50b075d..df7fcf2 100644 --- a/docs/.vitepress/sidebar.ts +++ b/docs/.vitepress/sidebar.ts @@ -36,10 +36,10 @@ export default { ], }, { - text: '🪚 PGA 介绍', + text: '🪚 扩展介绍', collapsed: true, items: [ - { text: '编译及安装', link: '/pga/build' }, + { text: 'PGA 编译及安装', link: '/extra/pga' }, ], }, ], diff --git a/docs/contributors.json b/docs/contributors.json index c240252..1ed2e12 100644 --- a/docs/contributors.json +++ b/docs/contributors.json @@ -15,5 +15,6 @@ "xr1s", "Nene07210721", "hakureiyuyuko", - "AnotiaWang" + "AnotiaWang", + "LeiShi1313" ] diff --git a/docs/pga/build.md b/docs/extra/pga.md similarity index 93% rename from docs/pga/build.md rename to docs/extra/pga.md index fb9ecb3..bf930a7 100644 --- a/docs/pga/build.md +++ b/docs/extra/pga.md @@ -11,8 +11,15 @@ PGA 主要依赖 Rust 以及 PyO3 实现与 `genshin_artifact` 的对接: - [PyO3](https://github.com/PyO3/pyo3) - [Python 3.8+](https://www.python.org/) +## PYPI 安装 -## 编译/安装 +[python-genshin-artifact](https://pypi.org/project/python-genshin-artifact/) + +``` +pip install python-genshin-artifact +``` + +## 编译安装 1. 克隆项目 @@ -52,7 +59,7 @@ PGA 主要依赖 Rust 以及 PyO3 实现与 `genshin_artifact` 的对接: ``` -## 编译 wheel +### 编译 wheel 如果需要导出给其它项目测试或使用(例如 PaiGram),需要通过 `maturin` 将模块编译成 `.whl` 格式以便其它 Python 虚拟环境安装。