aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2024-03-10 07:08:44 +0800
committer简律纯 <i@jyunko.cn>2024-03-10 07:08:44 +0800
commit2a43b4540ffd94667b4cf1aaac04654497f7f692 (patch)
tree7de081518cca6d29e1dcc641ff7613564ac5c673
parentd8c68acdcf29f62589197f15fdb394df7ff7a049 (diff)
downloadHydroRoll-2a43b4540ffd94667b4cf1aaac04654497f7f692.tar.gz
HydroRoll-2a43b4540ffd94667b4cf1aaac04654497f7f692.zip
chore(docs): complete page
-rw-r--r--docs/source/api/hydro_roll.cli.rst7
-rw-r--r--docs/source/api/hydro_roll.config.rst7
-rw-r--r--docs/source/api/hydro_roll.exceptions.rst7
-rw-r--r--docs/source/api/hydro_roll.hydro_roll.rst7
-rw-r--r--docs/source/api/hydro_roll.models.rst18
-rw-r--r--docs/source/api/hydro_roll.models.utils.rst7
-rw-r--r--docs/source/api/hydro_roll.rst31
-rw-r--r--docs/source/api/hydro_roll.typing.rst7
-rw-r--r--docs/source/api/hydro_roll.utils.rst7
-rw-r--r--docs/source/api/index.rst7
-rw-r--r--docs/source/community/asset_library/index.rst1
-rw-r--r--docs/source/community/channels.rst1
-rw-r--r--docs/source/community/tutorials.rst1
-rw-r--r--docs/source/contributing/development/index.rst1
-rw-r--r--docs/source/contributing/documentation/index.rst1
-rw-r--r--docs/source/contributing/ways_to_contribute.rst1
-rw-r--r--docs/source/contributing/workflow.rst1
-rw-r--r--docs/source/index.rst2
-rw-r--r--docs/source/tutorials/all_in_configuration.rst1
-rw-r--r--docs/source/tutorials/ast_and_tts/index.rst1
-rw-r--r--docs/source/tutorials/best_practices/index.rst0
-rw-r--r--docs/source/tutorials/logshader/index.rst1
-rw-r--r--docs/source/tutorials/migrating/index.rst1
-rw-r--r--docs/source/tutorials/nature_language_processing/index.rst1
-rw-r--r--docs/source/tutorials/nivis_grammar/index.rst1
-rw-r--r--docs/source/tutorials/oneroll_grammar/index.rst1
-rw-r--r--docs/source/tutorials/performance/index.rst1
-rw-r--r--docs/source/tutorials/platform/index.rst1
-rw-r--r--docs/source/tutorials/scripts/index.rst1
-rw-r--r--docs/source/tutorials/troubleshooting.rst0
-rw-r--r--docs/source/tutorials/use_cli.rst0
-rw-r--r--docs/source/tutorials/webui/index.rst1
32 files changed, 124 insertions, 1 deletions
diff --git a/docs/source/api/hydro_roll.cli.rst b/docs/source/api/hydro_roll.cli.rst
new file mode 100644
index 0000000..93c24fe
--- /dev/null
+++ b/docs/source/api/hydro_roll.cli.rst
@@ -0,0 +1,7 @@
+hydro\_roll.cli module
+======================
+
+.. automodule:: hydro_roll.cli
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.config.rst b/docs/source/api/hydro_roll.config.rst
new file mode 100644
index 0000000..026e76c
--- /dev/null
+++ b/docs/source/api/hydro_roll.config.rst
@@ -0,0 +1,7 @@
+hydro\_roll.config module
+=========================
+
+.. automodule:: hydro_roll.config
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.exceptions.rst b/docs/source/api/hydro_roll.exceptions.rst
new file mode 100644
index 0000000..bccb1d3
--- /dev/null
+++ b/docs/source/api/hydro_roll.exceptions.rst
@@ -0,0 +1,7 @@
+hydro\_roll.exceptions module
+=============================
+
+.. automodule:: hydro_roll.exceptions
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.hydro_roll.rst b/docs/source/api/hydro_roll.hydro_roll.rst
new file mode 100644
index 0000000..f4a11bb
--- /dev/null
+++ b/docs/source/api/hydro_roll.hydro_roll.rst
@@ -0,0 +1,7 @@
+hydro\_roll.hydro\_roll module
+==============================
+
+.. automodule:: hydro_roll.hydro_roll
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.models.rst b/docs/source/api/hydro_roll.models.rst
new file mode 100644
index 0000000..50723e0
--- /dev/null
+++ b/docs/source/api/hydro_roll.models.rst
@@ -0,0 +1,18 @@
+hydro\_roll.models package
+==========================
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ hydro_roll.models.utils
+
+Module contents
+---------------
+
+.. automodule:: hydro_roll.models
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.models.utils.rst b/docs/source/api/hydro_roll.models.utils.rst
new file mode 100644
index 0000000..aacd2e9
--- /dev/null
+++ b/docs/source/api/hydro_roll.models.utils.rst
@@ -0,0 +1,7 @@
+hydro\_roll.models.utils module
+===============================
+
+.. automodule:: hydro_roll.models.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.rst b/docs/source/api/hydro_roll.rst
new file mode 100644
index 0000000..136c69d
--- /dev/null
+++ b/docs/source/api/hydro_roll.rst
@@ -0,0 +1,31 @@
+hydro\_roll package
+===================
+
+Subpackages
+-----------
+
+.. toctree::
+ :maxdepth: 4
+
+ hydro_roll.models
+
+Submodules
+----------
+
+.. toctree::
+ :maxdepth: 4
+
+ hydro_roll.cli
+ hydro_roll.config
+ hydro_roll.exceptions
+ hydro_roll.hydro_roll
+ hydro_roll.typing
+ hydro_roll.utils
+
+Module contents
+---------------
+
+.. automodule:: hydro_roll
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.typing.rst b/docs/source/api/hydro_roll.typing.rst
new file mode 100644
index 0000000..6638d5c
--- /dev/null
+++ b/docs/source/api/hydro_roll.typing.rst
@@ -0,0 +1,7 @@
+hydro\_roll.typing module
+=========================
+
+.. automodule:: hydro_roll.typing
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/hydro_roll.utils.rst b/docs/source/api/hydro_roll.utils.rst
new file mode 100644
index 0000000..3083df1
--- /dev/null
+++ b/docs/source/api/hydro_roll.utils.rst
@@ -0,0 +1,7 @@
+hydro\_roll.utils module
+========================
+
+.. automodule:: hydro_roll.utils
+ :members:
+ :undoc-members:
+ :show-inheritance:
diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst
new file mode 100644
index 0000000..0216263
--- /dev/null
+++ b/docs/source/api/index.rst
@@ -0,0 +1,7 @@
+hydro_roll
+==========
+
+.. toctree::
+ :maxdepth: 4
+
+ hydro_roll
diff --git a/docs/source/community/asset_library/index.rst b/docs/source/community/asset_library/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/community/asset_library/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/community/channels.rst b/docs/source/community/channels.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/community/channels.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/community/tutorials.rst b/docs/source/community/tutorials.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/community/tutorials.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/contributing/development/index.rst b/docs/source/contributing/development/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/contributing/development/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/contributing/documentation/index.rst b/docs/source/contributing/documentation/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/contributing/documentation/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/contributing/ways_to_contribute.rst b/docs/source/contributing/ways_to_contribute.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/contributing/ways_to_contribute.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/contributing/workflow.rst b/docs/source/contributing/workflow.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/contributing/workflow.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/index.rst b/docs/source/index.rst
index f1a41cc..3cee716 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -46,7 +46,7 @@
性能比较与建议 <tutorials/performance/index.rst>
平台相关 <tutorials/platform/index.rst>
脚本插件 <tutorials/scripts/index.rst>
- 跑团记录着色器 <tutorials/logshader/index.rst>
+ 跑团日志记录着色器 <tutorials/logshader/index.rst>
.. toctree::
diff --git a/docs/source/tutorials/all_in_configuration.rst b/docs/source/tutorials/all_in_configuration.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/all_in_configuration.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/ast_and_tts/index.rst b/docs/source/tutorials/ast_and_tts/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/ast_and_tts/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/best_practices/index.rst b/docs/source/tutorials/best_practices/index.rst
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/source/tutorials/best_practices/index.rst
diff --git a/docs/source/tutorials/logshader/index.rst b/docs/source/tutorials/logshader/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/logshader/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/migrating/index.rst b/docs/source/tutorials/migrating/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/migrating/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/nature_language_processing/index.rst b/docs/source/tutorials/nature_language_processing/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/nature_language_processing/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/nivis_grammar/index.rst b/docs/source/tutorials/nivis_grammar/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/nivis_grammar/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/oneroll_grammar/index.rst b/docs/source/tutorials/oneroll_grammar/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/oneroll_grammar/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/performance/index.rst b/docs/source/tutorials/performance/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/performance/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/platform/index.rst b/docs/source/tutorials/platform/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/platform/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/scripts/index.rst b/docs/source/tutorials/scripts/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/scripts/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬
diff --git a/docs/source/tutorials/troubleshooting.rst b/docs/source/tutorials/troubleshooting.rst
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/source/tutorials/troubleshooting.rst
diff --git a/docs/source/tutorials/use_cli.rst b/docs/source/tutorials/use_cli.rst
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/source/tutorials/use_cli.rst
diff --git a/docs/source/tutorials/webui/index.rst b/docs/source/tutorials/webui/index.rst
new file mode 100644
index 0000000..88d421b
--- /dev/null
+++ b/docs/source/tutorials/webui/index.rst
@@ -0,0 +1 @@
+ECHO ڴ״̬