diff options
| author |   简律纯 <i@jyunko.cn> | 2024-03-10 22:30:01 +0800 |
|---|---|---|
| committer | 简律纯 <i@jyunko.cn> | 2024-03-10 22:30:01 +0800 |
| commit | 455ca3e3db84f36ae9464468de54f7aa693a3dd2 (patch) | |
| tree | dc115643fdeb21ec03c9df0065493f2e549f88f8 | |
| parent | a4c6355d994d26a5413bc350f3e7a57f344296f2 (diff) | |
| download | HydroRoll-455ca3e3db84f36ae9464468de54f7aa693a3dd2.tar.gz HydroRoll-455ca3e3db84f36ae9464468de54f7aa693a3dd2.zip | |
fix(docs): toc tree repair
34 files changed, 116 insertions, 51 deletions
diff --git a/docs/source/about/index.rst b/docs/source/about/index.rst index d4217a0..9a37734 100644 --- a/docs/source/about/index.rst +++ b/docs/source/about/index.rst @@ -2,6 +2,7 @@ ==== .. toctree:: + :hidden: introduction list_of_features diff --git a/docs/source/community/asset_library/index.rst b/docs/source/community/asset_library/index.rst index 88d421b..0bc7a55 100644 --- a/docs/source/community/asset_library/index.rst +++ b/docs/source/community/asset_library/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +资产库 +======
\ No newline at end of file diff --git a/docs/source/community/channels.rst b/docs/source/community/channels.rst index 88d421b..03927e3 100644 --- a/docs/source/community/channels.rst +++ b/docs/source/community/channels.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +社区渠道 +========
\ No newline at end of file diff --git a/docs/source/community/index.rst b/docs/source/community/index.rst new file mode 100644 index 0000000..cc4fa87 --- /dev/null +++ b/docs/source/community/index.rst @@ -0,0 +1,8 @@ +社区 +==== + +.. toctree:: + + asset_library + channels + tutorials
\ No newline at end of file diff --git a/docs/source/community/tutorials.rst b/docs/source/community/tutorials.rst index 88d421b..ff4efcb 100644 --- a/docs/source/community/tutorials.rst +++ b/docs/source/community/tutorials.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +教程与资源 +==========
\ No newline at end of file diff --git a/docs/source/contributing/development/index.rst b/docs/source/contributing/development/index.rst index 88d421b..3b1e419 100644 --- a/docs/source/contributing/development/index.rst +++ b/docs/source/contributing/development/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +框架开发 +========
\ No newline at end of file diff --git a/docs/source/contributing/documentation/index.rst b/docs/source/contributing/documentation/index.rst index 88d421b..1ffd6b0 100644 --- a/docs/source/contributing/documentation/index.rst +++ b/docs/source/contributing/documentation/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +编写文档 +========
\ No newline at end of file diff --git a/docs/source/contributing/index.rst b/docs/source/contributing/index.rst new file mode 100644 index 0000000..22d1982 --- /dev/null +++ b/docs/source/contributing/index.rst @@ -0,0 +1,9 @@ +贡献 +==== + +.. toctree:: + + ways_to_contribute + workflow + development + documentation
\ No newline at end of file diff --git a/docs/source/contributing/ways_to_contribute.rst b/docs/source/contributing/ways_to_contribute.rst index 88d421b..4df6f6e 100644 --- a/docs/source/contributing/ways_to_contribute.rst +++ b/docs/source/contributing/ways_to_contribute.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +贡献方式 +========
\ No newline at end of file diff --git a/docs/source/contributing/workflow.rst b/docs/source/contributing/workflow.rst index 88d421b..6815faa 100644 --- a/docs/source/contributing/workflow.rst +++ b/docs/source/contributing/workflow.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +贡献工作流 +==========
\ No newline at end of file diff --git a/docs/source/getting_started/first_dice_system/index.rst b/docs/source/getting_started/first_dice_system/index.rst new file mode 100644 index 0000000..5b50895 --- /dev/null +++ b/docs/source/getting_started/first_dice_system/index.rst @@ -0,0 +1,2 @@ +你的第一个骰系 +==============
\ No newline at end of file diff --git a/docs/source/getting_started/first_language_model/index.rst b/docs/source/getting_started/first_language_model/index.rst new file mode 100644 index 0000000..75e9a7b --- /dev/null +++ b/docs/source/getting_started/first_language_model/index.rst @@ -0,0 +1,2 @@ +你的第一个智能语言模型 +=====================
\ No newline at end of file diff --git a/docs/source/getting_started/first_rule_book_impl/index.rst b/docs/source/getting_started/first_rule_book_impl/index.rst new file mode 100644 index 0000000..3a5ad87 --- /dev/null +++ b/docs/source/getting_started/first_rule_book_impl/index.rst @@ -0,0 +1,2 @@ +你的第一个规则书实现 +===================
\ No newline at end of file diff --git a/docs/source/getting_started/first_script/index.rst b/docs/source/getting_started/first_script/index.rst new file mode 100644 index 0000000..256a8cc --- /dev/null +++ b/docs/source/getting_started/first_script/index.rst @@ -0,0 +1,2 @@ +你的第一个脚本插件 +==================
\ No newline at end of file diff --git a/docs/source/getting_started/index.rst b/docs/source/getting_started/index.rst new file mode 100644 index 0000000..b8f8de2 --- /dev/null +++ b/docs/source/getting_started/index.rst @@ -0,0 +1,11 @@ +入门 +==== + +.. toctree:: + + introduction + step_by_step + first_dice_system + first_script + first_rule_book_impl + first_language_model
\ No newline at end of file diff --git a/docs/source/getting_started/introduction/index.rst b/docs/source/getting_started/introduction/index.rst new file mode 100644 index 0000000..83ebbb8 --- /dev/null +++ b/docs/source/getting_started/introduction/index.rst @@ -0,0 +1,2 @@ +前言 +====
\ No newline at end of file diff --git a/docs/source/getting_started/step_by_step/index.rst b/docs/source/getting_started/step_by_step/index.rst new file mode 100644 index 0000000..c156940 --- /dev/null +++ b/docs/source/getting_started/step_by_step/index.rst @@ -0,0 +1,2 @@ +渐进式教程 +==========
\ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index e32ced0..8877ba8 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -8,58 +8,31 @@ .. toctree:: :hidden: - 关于 <about/index.rst> + about .. toctree:: :hidden: - :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> + getting_started .. toctree:: :hidden: - :caption: 手册 - - 最佳实践 <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> + tutorials + .. toctree:: :hidden: - :caption: 贡献 - 贡献方式 <contributing/ways_to_contribute.rst> - 贡献工作流 <contributing/workflow.rst> - 框架开发 <contributing/development/index.rst> - 编写文档 <contributing/documentation/index.rst> + contributing .. toctree:: :hidden: - :caption: 社区 - 资产库 <community/asset_library/index.rst> - 社区渠道 <community/channels.rst> - 教程与资源 <community/tutorials.rst> + community .. toctree:: diff --git a/docs/source/tutorials/all_in_configuration.rst b/docs/source/tutorials/all_in_configuration.rst index 88d421b..2ca516e 100644 --- a/docs/source/tutorials/all_in_configuration.rst +++ b/docs/source/tutorials/all_in_configuration.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +一切皆配置 +==========
\ No newline at end of file diff --git a/docs/source/tutorials/ast_and_tts/index.rst b/docs/source/tutorials/ast_and_tts/index.rst index 88d421b..b770268 100644 --- a/docs/source/tutorials/ast_and_tts/index.rst +++ b/docs/source/tutorials/ast_and_tts/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +ASR&TTS 音频处理 +================
\ No newline at end of file diff --git a/docs/source/tutorials/best_practices/index.rst b/docs/source/tutorials/best_practices/index.rst index e69de29..0e67420 100644 --- a/docs/source/tutorials/best_practices/index.rst +++ b/docs/source/tutorials/best_practices/index.rst @@ -0,0 +1,7 @@ +最佳实践 +======== + +.. toctree:: + + introduction_best_practices +
\ No newline at end of file diff --git a/docs/source/tutorials/best_practices/introduction_best_practices.rst b/docs/source/tutorials/best_practices/introduction_best_practices.rst new file mode 100644 index 0000000..83ebbb8 --- /dev/null +++ b/docs/source/tutorials/best_practices/introduction_best_practices.rst @@ -0,0 +1,2 @@ +前言 +====
\ No newline at end of file diff --git a/docs/source/tutorials/index.rst b/docs/source/tutorials/index.rst new file mode 100644 index 0000000..6faeb12 --- /dev/null +++ b/docs/source/tutorials/index.rst @@ -0,0 +1,19 @@ +手册 +==== + +.. toctree:: + + best_practices + troubleshooting + use_cli + migrating + all_in_configuration + webui + nivis_grammar + oneroll_grammar + nature_language_processing + ast_and_tts + performance + platform + scripts + logshader diff --git a/docs/source/tutorials/logshader/index.rst b/docs/source/tutorials/logshader/index.rst index 88d421b..d62c5f7 100644 --- a/docs/source/tutorials/logshader/index.rst +++ b/docs/source/tutorials/logshader/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +跑团日志记录着色器 +=================
\ No newline at end of file diff --git a/docs/source/tutorials/migrating/index.rst b/docs/source/tutorials/migrating/index.rst index 88d421b..06447e9 100644 --- a/docs/source/tutorials/migrating/index.rst +++ b/docs/source/tutorials/migrating/index.rst @@ -1 +1,3 @@ -ECHO ڴ״̬ +迁移到新版本 +============ + diff --git a/docs/source/tutorials/nature_language_processing/index.rst b/docs/source/tutorials/nature_language_processing/index.rst index 88d421b..93f768a 100644 --- a/docs/source/tutorials/nature_language_processing/index.rst +++ b/docs/source/tutorials/nature_language_processing/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +NLP 自然语言处理 +================
\ No newline at end of file diff --git a/docs/source/tutorials/nivis_grammar/index.rst b/docs/source/tutorials/nivis_grammar/index.rst index 88d421b..8a1b98b 100644 --- a/docs/source/tutorials/nivis_grammar/index.rst +++ b/docs/source/tutorials/nivis_grammar/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +Nivis 语法指南 +==============
\ No newline at end of file diff --git a/docs/source/tutorials/oneroll_grammar/index.rst b/docs/source/tutorials/oneroll_grammar/index.rst index 88d421b..0c8db57 100644 --- a/docs/source/tutorials/oneroll_grammar/index.rst +++ b/docs/source/tutorials/oneroll_grammar/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +OneRoll 语法指南 +================
\ No newline at end of file diff --git a/docs/source/tutorials/performance/index.rst b/docs/source/tutorials/performance/index.rst index 88d421b..bb01933 100644 --- a/docs/source/tutorials/performance/index.rst +++ b/docs/source/tutorials/performance/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +性能比较与建议 +==============
\ No newline at end of file diff --git a/docs/source/tutorials/platform/index.rst b/docs/source/tutorials/platform/index.rst index 88d421b..c5f1fd6 100644 --- a/docs/source/tutorials/platform/index.rst +++ b/docs/source/tutorials/platform/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +平台相关 +========
\ No newline at end of file diff --git a/docs/source/tutorials/scripts/index.rst b/docs/source/tutorials/scripts/index.rst index 88d421b..e488821 100644 --- a/docs/source/tutorials/scripts/index.rst +++ b/docs/source/tutorials/scripts/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +脚本插件 +========
\ No newline at end of file diff --git a/docs/source/tutorials/troubleshooting.rst b/docs/source/tutorials/troubleshooting.rst index e69de29..7c8a2c2 100644 --- a/docs/source/tutorials/troubleshooting.rst +++ b/docs/source/tutorials/troubleshooting.rst @@ -0,0 +1,2 @@ +故障排除 +========
\ No newline at end of file diff --git a/docs/source/tutorials/use_cli.rst b/docs/source/tutorials/use_cli.rst index e69de29..3adc6ba 100644 --- a/docs/source/tutorials/use_cli.rst +++ b/docs/source/tutorials/use_cli.rst @@ -0,0 +1,2 @@ +使用脚手架 +==========
\ No newline at end of file diff --git a/docs/source/tutorials/webui/index.rst b/docs/source/tutorials/webui/index.rst index 88d421b..40f7701 100644 --- a/docs/source/tutorials/webui/index.rst +++ b/docs/source/tutorials/webui/index.rst @@ -1 +1,2 @@ -ECHO ڴ״̬ +WebUI 使用 +==========
\ No newline at end of file |