aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
authorNtkskwk <natsukawa247@outlook.com>2024-09-02 21:36:49 +0800
committerNtkskwk <natsukawa247@outlook.com>2024-09-02 21:36:49 +0800
commit9b1eee076802ac87a7ccaf30cd135a2c7198c60a (patch)
tree42879cc61d5284c22002ea3452a1b912b4aa8c99
parente30752e59013997351399420412785973e56fd2f (diff)
downloadHydroRoll-9b1eee076802ac87a7ccaf30cd135a2c7198c60a.tar.gz
HydroRoll-9b1eee076802ac87a7ccaf30cd135a2c7198c60a.zip
style(docs): Resolve warnings about underscores being too short
-rw-r--r--docs/requirements.txt3
-rw-r--r--docs/source/about/complying_with_licenses.rst8
-rw-r--r--docs/source/about/faq.rst38
-rw-r--r--docs/source/about/introduction.rst8
-rw-r--r--docs/source/about/list_of_features.rst16
-rw-r--r--docs/source/about/release_policy.rst12
-rw-r--r--docs/source/about/system_requirements.rst4
-rw-r--r--docs/source/community/code-of-conduct.rst10
-rw-r--r--docs/source/getting_started/first_language_model/index.rst2
-rw-r--r--docs/source/getting_started/first_rule_book_impl/index.rst2
-rw-r--r--docs/source/index.rst2
-rw-r--r--docs/source/tutorials/logshader/index.rst2
12 files changed, 53 insertions, 54 deletions
diff --git a/docs/requirements.txt b/docs/requirements.txt
index 899492a..3945c31 100644
--- a/docs/requirements.txt
+++ b/docs/requirements.txt
@@ -4,4 +4,5 @@ myst-parser>=0.18.1
sphinx>=5.3.0
tomli
sphinx_design
-sphinx-intl>=2.1.0 \ No newline at end of file
+sphinx-intl>=2.1.0
+hydro-roll[dev] \ No newline at end of file
diff --git a/docs/source/about/complying_with_licenses.rst b/docs/source/about/complying_with_licenses.rst
index 1402bc7..8fa2ae2 100644
--- a/docs/source/about/complying_with_licenses.rst
+++ b/docs/source/about/complying_with_licenses.rst
@@ -2,13 +2,13 @@
==========
什么是许可证?
--------------
+---------------
需求
-----
+---------------
包含
-----
+---------------
第三方许可证
------------- \ No newline at end of file
+--------------- \ No newline at end of file
diff --git a/docs/source/about/faq.rst b/docs/source/about/faq.rst
index 016e962..2c89e9a 100644
--- a/docs/source/about/faq.rst
+++ b/docs/source/about/faq.rst
@@ -2,57 +2,55 @@
========
可以用水系做什么?需要花多少钱?有哪些许可条款?
----------------------------------------------
+----------------------------------------------------------------
水系支持哪些平台?
-----------------
+--------------------------------
水系支持哪些编程语言?
---------------------
+--------------------------------
Nivis 是什么?为什么要用它?
---------------------------
+--------------------------------
创建 Nivis 背后的动机是什么?
----------------------------
+--------------------------------
水系会支持【此处插入赵骰、星骰、溯洄/shiki 等闭源或半闭源骰系/核心/驱动的名字】的模块化吗?
--------------------------------------------------------------------------------------
+---------------------------------------------------------------------------------------------------------------------
如何扩展水系?
--------------
+------------------------------------------------------------------
如何在我的系统上安装 HydroRoll 水系框架(进行桌面集成)?
-------------------------------------------------------
+------------------------------------------------------------------
HydroRoll 水系是绿色应用/软件/程序吗?
-------------------------------------
+------------------------------------------------------------------
为什么水系基于规则包构建?
-------------------------
+------------------------------------------------------------------
如何适配多个平台、协议,其他骰系的模块化,资产应做哪些处理?
---------------------------------------------------------
+------------------------------------------------------------------
HydroRoll 的下一个版本什么时候发布?
---------------------------------------
+------------------------------------------------------------------
新的骰系项目/模型项目使用哪个版本的 HydroRoll?
----------------------------------------------
+------------------------------------------------------------------
是否需要将我的项目升级到 HydroRoll 最新版本?
-------------------------------------------
+------------------------------------------------------------------
我想要贡献!该如何开始?
-----------------------
+------------------------------------------------------------------
我有一个关于 HydroRoll 的好主意,该如何分享它?
----------------------------------------------
+------------------------------------------------------------------
能否用 HydroRoll 创建非 TRPG/TTRPG 系统?
-----------------------------------------
+------------------------------------------------------------------
是否能够将 HydroRoll 作为库使用?
--------------------------------
-
-
+------------------------------------------------------------------
diff --git a/docs/source/about/introduction.rst b/docs/source/about/introduction.rst
index bde8bed..02c627a 100644
--- a/docs/source/about/introduction.rst
+++ b/docs/source/about/introduction.rst
@@ -2,15 +2,15 @@
====
在开始之前
----------
+----------------------------
关于 HydroRoll 水系
-------------------
+----------------------------
文档结构
--------
+----------------------------
关于本文档
----------
+----------------------------
diff --git a/docs/source/about/list_of_features.rst b/docs/source/about/list_of_features.rst
index 89b4c6a..6bfa49f 100644
--- a/docs/source/about/list_of_features.rst
+++ b/docs/source/about/list_of_features.rst
@@ -17,25 +17,25 @@
--------
模块化
-------
+----------------
去中心化
---------
+----------------
跨平台
-------
+----------------
脚本插件
---------
+----------------
掷骰表达式解析
--------------
+----------------
人工智能
---------
+----------------
渐进式
-------
+----------------
杂项
----- \ No newline at end of file
+---------------- \ No newline at end of file
diff --git a/docs/source/about/release_policy.rst b/docs/source/about/release_policy.rst
index bf4d265..33a60da 100644
--- a/docs/source/about/release_policy.rst
+++ b/docs/source/about/release_policy.rst
@@ -2,19 +2,19 @@
============
HydroRoll 版本
---------------
+------------------------------------------
发布支持时间表
---------------
+------------------------------------------
新项目应该使用哪个版本?
-----------------------
+------------------------------------------
我应该把项目升级到新版本的水系框架吗?
------------------------------------
+------------------------------------------
下一个版本什么时候发布?
-----------------------
+------------------------------------------
水系框架版本之间的兼容标准是怎样的?
---------------------------------- \ No newline at end of file
+------------------------------------------ \ No newline at end of file
diff --git a/docs/source/about/system_requirements.rst b/docs/source/about/system_requirements.rst
index 8f4b883..3151c01 100644
--- a/docs/source/about/system_requirements.rst
+++ b/docs/source/about/system_requirements.rst
@@ -2,7 +2,7 @@
========
开发水系
---------
+----------------
运行水系
--------- \ No newline at end of file
+---------------- \ No newline at end of file
diff --git a/docs/source/community/code-of-conduct.rst b/docs/source/community/code-of-conduct.rst
index 977e032..e9da725 100644
--- a/docs/source/community/code-of-conduct.rst
+++ b/docs/source/community/code-of-conduct.rst
@@ -2,7 +2,7 @@
==========
我们的承诺
----------
+------------------
身为社区成员、贡献者和领袖,我们承诺使社区参与者不受骚扰,无论其年龄、体型、可见或不可见的缺陷、族裔、性征、性别认同和表达、经验水平、教育程度、社会与经济地位、国籍、相貌、种族、种姓、肤色、宗教信仰、性倾向或性取向如何。
@@ -10,7 +10,7 @@
我们的准则
----------
+------------------
有助于为我们的社区创造积极环境的行为例子包括但不限于:
@@ -30,7 +30,7 @@
责任和权力
----------
+------------------
社区领袖有责任解释和落实我们所认可的行为准则,并妥善公正地对他们认为不当、威胁、冒犯或有害的任何行为采取纠正措施。
@@ -38,7 +38,7 @@
适用范围
---------
+-----------------
本行为准则适用于所有社区场合,也适用于在公共场所代表社区时的个人。
@@ -46,7 +46,7 @@
监督
-----
+--------
辱骂、骚扰或其他不可接受的行为可通过 [插入联系方式] 向负责监督的社区领袖报告。
所有投诉都将得到及时和公平的审查和调查。
diff --git a/docs/source/getting_started/first_language_model/index.rst b/docs/source/getting_started/first_language_model/index.rst
index 75e9a7b..98d5a59 100644
--- a/docs/source/getting_started/first_language_model/index.rst
+++ b/docs/source/getting_started/first_language_model/index.rst
@@ -1,2 +1,2 @@
你的第一个智能语言模型
-===================== \ No newline at end of file
+========================================== \ 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
index 3a5ad87..73416b9 100644
--- a/docs/source/getting_started/first_rule_book_impl/index.rst
+++ b/docs/source/getting_started/first_rule_book_impl/index.rst
@@ -1,2 +1,2 @@
你的第一个规则书实现
-=================== \ No newline at end of file
+====================================== \ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3c4827b..0894b44 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,7 +1,7 @@
.. hide-toc: true
跨平台、多模态、高度自定义的骰系开发框架
-=======================================
+===========================================================
.. include:: ../../README.rst
:start-after: start-index
diff --git a/docs/source/tutorials/logshader/index.rst b/docs/source/tutorials/logshader/index.rst
index d62c5f7..4c84003 100644
--- a/docs/source/tutorials/logshader/index.rst
+++ b/docs/source/tutorials/logshader/index.rst
@@ -1,2 +1,2 @@
跑团日志记录着色器
-================= \ No newline at end of file
+================================== \ No newline at end of file