diff options
| author | 2024-03-04 14:03:59 +0800 | |
|---|---|---|
| committer | 2024-03-04 14:03:59 +0800 | |
| commit | f8f88f465df244be685679a6a78bf4b27008672d (patch) | |
| tree | 2790f9496e3efb14323c69e0e1b763bd89d0def7 /docs | |
| parent | c3ce35da99ff77007431e501415784e9dc015990 (diff) | |
| download | infini-f8f88f465df244be685679a6a78bf4b27008672d.tar.gz infini-f8f88f465df244be685679a6a78bf4b27008672d.zip | |
docs(quick-start): add quick start content
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/conf.py | 11 | ||||
| -rw-r--r-- | docs/source/index.md | 8 | ||||
| -rw-r--r-- | docs/source/pages/grps/index.md (renamed from docs/source/pages/grps-1/index.md) | 0 | ||||
| -rw-r--r-- | docs/source/quick-start.md | 20 |
4 files changed, 31 insertions, 8 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py index 9890225d..56e6723d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -24,14 +24,14 @@ AUTHORS = ",".join([f"{aut['name']}" for aut in AUTHOR_TABLE]) # -- Project information ----------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = PROJECT_NAME # "Infini" -release = PROJECT_VERSION # "latest" +project = PROJECT_NAME +release = PROJECT_VERSION copyright = ( - "2023-PRESENT, HydroRoll-Team & 浊莲." + "2023-PRESENT, HydroRoll-Team & Noctisynth, org." ) -author = AUTHORS # "Hsiang Nianian" +author = AUTHORS -html_title = "INFINI GENERATOR II" +html_title = "Infini II" # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration @@ -78,7 +78,6 @@ html_css_files = [ ] html_theme_options = { - # "announcement": "<em><a href='#'>documentation</a> is still under construction now, welcome any <a href='contributing.html'>contribution</a>!</em>", "source_repository": "https://github.com/HydroRoll-Team/infini/", "source_branch": "master", "source_directory": "docs/source/", diff --git a/docs/source/index.md b/docs/source/index.md index 61be949d..b3f8b274 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -12,6 +12,12 @@ hide-toc: true ```{toctree} :hidden: +简述 <index> +``` + +```{toctree} +:hidden: + 快速开始 <quick-start> ``` @@ -19,7 +25,7 @@ hide-toc: true :caption: 通用规则包标准 :hidden: -pages/grps-1/index +pages/grps/index ``` ```{toctree} diff --git a/docs/source/pages/grps-1/index.md b/docs/source/pages/grps/index.md index d56fffd9..d56fffd9 100644 --- a/docs/source/pages/grps-1/index.md +++ b/docs/source/pages/grps/index.md diff --git a/docs/source/quick-start.md b/docs/source/quick-start.md index 55b6f79f..6a35bccf 100644 --- a/docs/source/quick-start.md +++ b/docs/source/quick-start.md @@ -1 +1,19 @@ -# 快速开始
\ No newline at end of file +# 快速开始 + +通过本文档,你可以快速开始学习如何使用 Infini 来构建一个规则包。请注意,如果你在查找如何使用 Infini,你可以前往 [Infini Adapters 文档](https://adapter.infini.hydroroll.team/)和[IPM 文档](https://ipm.hydroroll.team/)来获取更多信息。 + +## 预先准备 + +### Python 环境 + +.. important:: 我们强烈建议使用最新版 Python 分发。 + +请先确保你正确安装并配置了 Python 环境,如果你的计算机上还没有一个 Python 安装,请先前往[Python 官网](https://www.python.org/downloads/)下载和安装 Python。 + +.. tip:: 如果你的网络环境较差,你可以使用[淘宝镜像网站](https://registry.npmmirror.com/binary.html?path=python/)下载 Python,安装时请注意选择将 Python 加入环境变量。 + +安装完成后,你可以打开系统终端执行`python -V`以及`pip -V`来确保 Python 被正确安装。 + +### Infini 包管理器 + +我们强烈推荐使用 Infini 包管理器——**IPM**来构建一个 Python 规则包。 |
