From e2c9fe71fd6133f9c97943cd6c7d664a73e94ab0 Mon Sep 17 00:00:00 2001
From: 简律纯 <i@jyunko.cn>
Date: Sun, 10 Mar 2024 06:42:58 +0800
Subject: refactor(docs)!: setup docs toc tree

---
 .vscode/settings.json                        |  3 +-
 docs/source/index.rst                        | 75 +++++++++++++++++++++-------
 docs/source/pages/api/index.rst              |  7 ---
 docs/source/pages/api/infini.core.rst        |  7 ---
 docs/source/pages/api/infini.exceptions.rst  |  7 ---
 docs/source/pages/api/infini.generator.rst   |  7 ---
 docs/source/pages/api/infini.handler.rst     |  7 ---
 docs/source/pages/api/infini.input.rst       |  7 ---
 docs/source/pages/api/infini.interceptor.rst |  7 ---
 docs/source/pages/api/infini.internal.rst    |  7 ---
 docs/source/pages/api/infini.loader.rst      |  7 ---
 docs/source/pages/api/infini.logging.rst     |  7 ---
 docs/source/pages/api/infini.output.rst      |  7 ---
 docs/source/pages/api/infini.queue.rst       |  7 ---
 docs/source/pages/api/infini.register.rst    |  7 ---
 docs/source/pages/api/infini.router.rst      |  7 ---
 docs/source/pages/api/infini.rst             | 31 ------------
 docs/source/pages/api/infini.typing.rst      |  7 ---
 docs/source/pages/grps-1/index.md            |  1 -
 19 files changed, 58 insertions(+), 157 deletions(-)
 delete mode 100644 docs/source/pages/api/index.rst
 delete mode 100644 docs/source/pages/api/infini.core.rst
 delete mode 100644 docs/source/pages/api/infini.exceptions.rst
 delete mode 100644 docs/source/pages/api/infini.generator.rst
 delete mode 100644 docs/source/pages/api/infini.handler.rst
 delete mode 100644 docs/source/pages/api/infini.input.rst
 delete mode 100644 docs/source/pages/api/infini.interceptor.rst
 delete mode 100644 docs/source/pages/api/infini.internal.rst
 delete mode 100644 docs/source/pages/api/infini.loader.rst
 delete mode 100644 docs/source/pages/api/infini.logging.rst
 delete mode 100644 docs/source/pages/api/infini.output.rst
 delete mode 100644 docs/source/pages/api/infini.queue.rst
 delete mode 100644 docs/source/pages/api/infini.register.rst
 delete mode 100644 docs/source/pages/api/infini.router.rst
 delete mode 100644 docs/source/pages/api/infini.rst
 delete mode 100644 docs/source/pages/api/infini.typing.rst
 delete mode 100644 docs/source/pages/grps-1/index.md

diff --git a/.vscode/settings.json b/.vscode/settings.json
index cd3defa..3087907 100644
--- a/.vscode/settings.json
+++ b/.vscode/settings.json
@@ -29,5 +29,6 @@
   },
   "python.formatting.provider": "none",
   "restructuredtext.preview.docutils.disabled": true,
-  "iis.configDir": ""
+  "iis.configDir": "",
+  "restructuredtext.preview.name": "sphinx"
 }
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index f7c2161..f1a41cc 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -7,32 +7,69 @@
 
 .. toctree::
     :hidden:
-    :caption: 用户手册
+    :caption: 关于
 
-..     第一步
-..     使用脚手架
-..     更多的配置
-..     webui 基础
-..     NIVIS 基本语法
-..     OneRoll 语法概览
-..     webui 进阶
-..     最佳实践
+    前言 <about/introduction.rst>
+    基本特性 <about/list_of_features.rst>
+    系统要求 <about/system_requirements.rst>
+    常见问题 <about/faq.rst>
+    遵循许可证 <about/complying_with_licenses/rst>
+    水系发布策略 <about/release_policy.rst>
+    变更日志 <about/changelog.rst>
 
 .. .. toctree::
     :hidden:
-    :caption: 开发手册
+    :caption: 入门
 
-..     成为脚本插件作者
-..     成为规则包作者
-..     成为模型作者
+    前言 <getting_started/introduction/index.rst>
+    渐进式教程 <getting_started/step_by_step/index.rst>
+    你的第一个骰系 <getting_started/first_dice_system/index.rst>
+    你的第一个脚本插件 <getting_started/first_script/index.rst>
+    你的第一个规则书实现 <getting_started/first_rule_book_impl/index.rst>
+    你的第一个智能语言模型 <getting_started/first_language_model/index.rst>
 
-..     API 文档
-..     开发建议
 
 .. toctree::
     :hidden:
-    :caption: Thanks and Credits
+    :caption: 手册
 
-..     社区贡献指南
-..     变更日志
-..     协议
\ No newline at end of file
+    最佳实践 <tutorials/best_practices/index.rst>
+    故障排除 <tutorials/troubleshooting.rst>
+    使用脚手架 <tutorials/use_cli.rst>
+    迁移到新版本 <tutorials/migrating/index.rst>
+    一切皆配置 <tutorials/all_in_configuration.rst>
+    WebUI 使用 <tutorials/webui/index.rst>
+    Nivis 语法指南 <tutorials/nivis_grammar/index.rst>
+    OneRoll 语法指南 <tutorials/oneroll_grammar/index.rst>
+    NLP 自然语言处理 <tutorials/nature_language_processing/index.rst>
+    ASR&TTS 音频处理 <tutorials/ast_and_tts/index.rst>
+    性能比较与建议 <tutorials/performance/index.rst>
+    平台相关 <tutorials/platform/index.rst>
+    脚本插件 <tutorials/scripts/index.rst>
+    跑团记录着色器 <tutorials/logshader/index.rst>
+
+
+.. toctree::
+    :hidden:
+    :caption: 贡献
+
+    贡献方式 <contributing/ways_to_contribute.rst>
+    贡献工作流 <contributing/workflow.rst>
+    框架开发 <contributing/development/index.rst>
+    编写文档 <contributing/documentation/index.rst>
+
+
+.. toctree::
+    :hidden:
+    :caption: 社区
+
+    资产库 <community/asset_library/index.rst>
+    社区渠道 <community/channels.rst>
+    教程与资源 <community/tutorials.rst>
+
+
+.. toctree::
+    :hidden:
+    :caption: 开放 API 手册
+
+    参考 <api/index.rst>
\ No newline at end of file
diff --git a/docs/source/pages/api/index.rst b/docs/source/pages/api/index.rst
deleted file mode 100644
index 704f2ae..0000000
--- a/docs/source/pages/api/index.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini
-======
-
-.. toctree::
-   :maxdepth: 4
-
-   infini
diff --git a/docs/source/pages/api/infini.core.rst b/docs/source/pages/api/infini.core.rst
deleted file mode 100644
index 084db94..0000000
--- a/docs/source/pages/api/infini.core.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.core module
-==================
-
-.. automodule:: infini.core
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.exceptions.rst b/docs/source/pages/api/infini.exceptions.rst
deleted file mode 100644
index bdc8ef6..0000000
--- a/docs/source/pages/api/infini.exceptions.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.exceptions module
-========================
-
-.. automodule:: infini.exceptions
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.generator.rst b/docs/source/pages/api/infini.generator.rst
deleted file mode 100644
index c5055ff..0000000
--- a/docs/source/pages/api/infini.generator.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.generator module
-=======================
-
-.. automodule:: infini.generator
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.handler.rst b/docs/source/pages/api/infini.handler.rst
deleted file mode 100644
index 5b7742c..0000000
--- a/docs/source/pages/api/infini.handler.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.handler module
-=====================
-
-.. automodule:: infini.handler
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.input.rst b/docs/source/pages/api/infini.input.rst
deleted file mode 100644
index 184a0b0..0000000
--- a/docs/source/pages/api/infini.input.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.input module
-===================
-
-.. automodule:: infini.input
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.interceptor.rst b/docs/source/pages/api/infini.interceptor.rst
deleted file mode 100644
index fa99039..0000000
--- a/docs/source/pages/api/infini.interceptor.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.interceptor module
-=========================
-
-.. automodule:: infini.interceptor
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.internal.rst b/docs/source/pages/api/infini.internal.rst
deleted file mode 100644
index e0abeb4..0000000
--- a/docs/source/pages/api/infini.internal.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.internal module
-======================
-
-.. automodule:: infini.internal
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.loader.rst b/docs/source/pages/api/infini.loader.rst
deleted file mode 100644
index 29d5832..0000000
--- a/docs/source/pages/api/infini.loader.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.loader module
-====================
-
-.. automodule:: infini.loader
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.logging.rst b/docs/source/pages/api/infini.logging.rst
deleted file mode 100644
index 8aa7635..0000000
--- a/docs/source/pages/api/infini.logging.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.logging module
-=====================
-
-.. automodule:: infini.logging
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.output.rst b/docs/source/pages/api/infini.output.rst
deleted file mode 100644
index 33ec78f..0000000
--- a/docs/source/pages/api/infini.output.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.output module
-====================
-
-.. automodule:: infini.output
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.queue.rst b/docs/source/pages/api/infini.queue.rst
deleted file mode 100644
index 19401f4..0000000
--- a/docs/source/pages/api/infini.queue.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.queue module
-===================
-
-.. automodule:: infini.queue
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.register.rst b/docs/source/pages/api/infini.register.rst
deleted file mode 100644
index 8719967..0000000
--- a/docs/source/pages/api/infini.register.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.register module
-======================
-
-.. automodule:: infini.register
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.router.rst b/docs/source/pages/api/infini.router.rst
deleted file mode 100644
index 512aa45..0000000
--- a/docs/source/pages/api/infini.router.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.router module
-====================
-
-.. automodule:: infini.router
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.rst b/docs/source/pages/api/infini.rst
deleted file mode 100644
index dbc0cd2..0000000
--- a/docs/source/pages/api/infini.rst
+++ /dev/null
@@ -1,31 +0,0 @@
-infini package
-==============
-
-Submodules
-----------
-
-.. toctree::
-   :maxdepth: 4
-
-   infini.core
-   infini.exceptions
-   infini.generator
-   infini.handler
-   infini.input
-   infini.interceptor
-   infini.internal
-   infini.loader
-   infini.logging
-   infini.output
-   infini.queue
-   infini.register
-   infini.router
-   infini.typing
-
-Module contents
----------------
-
-.. automodule:: infini
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/api/infini.typing.rst b/docs/source/pages/api/infini.typing.rst
deleted file mode 100644
index cb13429..0000000
--- a/docs/source/pages/api/infini.typing.rst
+++ /dev/null
@@ -1,7 +0,0 @@
-infini.typing module
-====================
-
-.. automodule:: infini.typing
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/source/pages/grps-1/index.md b/docs/source/pages/grps-1/index.md
deleted file mode 100644
index d56fffd..0000000
--- a/docs/source/pages/grps-1/index.md
+++ /dev/null
@@ -1 +0,0 @@
-# 通用规则包标准
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2